arshadkazmi42 / ak-phrase.js

JS - Generates permutations of all sentences, using list of words :tada:

Hi 👋 I am Arshad

Backend Developer & Opensource Contributor

🌍  I'm based in Berlin, Germany
🖥️  See my portfolio at arshadkazmi42.github.io
✉️  You can contact me at [email protected]

Socials

Skills

Badges

My GitHub Stats

ak-phrase.js's Issues

Add license badge

[![LICENSE](https://img.shields.io/npm/l/ak-phrase.svg)](https://github.com/arshadkazmi42/ak-phrase.js/LICENSE)

add above line in README.md with other badges

Add null input check

Add null input check condition in index.js generateSentences

Add description in package.json

Add description in package.json, which will be shown as short discription on npm

Generates all the permutations of sentences from words in a 2D array.

Add build badge

Add build badge at the top in readme.md
This is the url for build badge

https://api.travis-ci.org/arshadkazmi42/ak-phrase.js.svg?branch=master

update package name in readme

The readme labels the wrong package name. The package name is ak-phrase not ak-phrase.js. You can check by running:
npm info ak-phrase.js vs npm info ak-phrase.

- $ npm install ak-phrasae.js
+ $ npm install ak-phrase

and

- const sentenceGenerator = require('ak-phrase.js');
+ const sentenceGenerator = require('ak-phrase');

This might also be a good chance to update the repo name to reflect the npm package name. Updating the docs count as a patch update: 1.0.3 -> 1.0.4

Add downloads badge

Add below downloads badge in readme with build badge

[![NPM Downloads](https://img.shields.io/npm/dt/ak-phrase.svg)](https://www.npmjs.com/package/ak-phrase)

Add npm version badge

[![NPM Version](https://img.shields.io/npm/v/ak-phrase.svg)](https://www.npmjs.com/package/ak-phrase)

Add above line in readme.md with other badges

Add LICENSE

Add GNU General Public License v3.0 license to the library

Add Contributors avatar

Add Contriutors avatar at bottom of the README.md file with title Contributors

Add the below code below the Contributors title

[![](https://sourcerer.io/fame/arshadkazmi42/arshadkazmi42/ak-phrase.js/images/0)](https://sourcerer.io/fame/arshadkazmi42/arshadkazmi42/ak-phrase.js/links/0)[![](https://sourcerer.io/fame/arshadkazmi42/arshadkazmi42/ak-phrase.js/images/1)](https://sourcerer.io/fame/arshadkazmi42/arshadkazmi42/ak-phrase.js/links/1)[![](https://sourcerer.io/fame/arshadkazmi42/arshadkazmi42/ak-phrase.js/images/2)](https://sourcerer.io/fame/arshadkazmi42/arshadkazmi42/ak-phrase.js/links/2)[![](https://sourcerer.io/fame/arshadkazmi42/arshadkazmi42/ak-phrase.js/images/3)](https://sourcerer.io/fame/arshadkazmi42/arshadkazmi42/ak-phrase.js/links/3)[![](https://sourcerer.io/fame/arshadkazmi42/arshadkazmi42/ak-phrase.js/images/4)](https://sourcerer.io/fame/arshadkazmi42/arshadkazmi42/ak-phrase.js/links/4)[![](https://sourcerer.io/fame/arshadkazmi42/arshadkazmi42/ak-phrase.js/images/5)](https://sourcerer.io/fame/arshadkazmi42/arshadkazmi42/ak-phrase.js/links/5)[![](https://sourcerer.io/fame/arshadkazmi42/arshadkazmi42/ak-phrase.js/images/6)](https://sourcerer.io/fame/arshadkazmi42/arshadkazmi42/ak-phrase.js/links/6)[![](https://sourcerer.io/fame/arshadkazmi42/arshadkazmi42/ak-phrase.js/images/7)](https://sourcerer.io/fame/arshadkazmi42/arshadkazmi42/ak-phrase.js/links/7)

add badges

Create first timers issues for adding badges

Add commit badge

[![Commit](https://img.shields.io/github/last-commit/arshadkazmi42/ak-phrase.js.svg)](https://github.com/arshadkazmi42/ak-phrase.js/commits/master)

adds commit badge

Change setenceGenerator to sentenceGenerator in README.md

Edit the typo in Usage section of README.md

Fix comment in index.js

Wrong comments are added in index.js, that needs to be updated

Change travis to github workflow

remove yarn.lock file

add eslint

We need to add eslint config to standardise the coding style

is generateSentencePermutations supposed to be exposed?

Noticed that generateSentences is not exported by default. generateSentencePermutations is already incorporated into generateSentences, thus I don't know if users are going to use it, especially as it is not documented in the readme. If there's no reason for users to use generateSentencePermutations function, then generateSentences can be the sole function exported by default. This would also require a change to the readme in how generateSentences is imported.

Add tests

Add tests to test the functionality

Add travis.yml

Add travis.yml in for CI

Change sentence index to wordIndex in index.js

Fix npm badges in README.md

Improve README.md

fix vulnerability

obese npm package

The packages includes every single file/folder in the repo. Packages should be as lightweight as possible. In this case, the only files that should be packed and sent to npm registry is the index.js, license, readme, and package.json.
In package.json add:

"files": ["index.js"]

The other 3 files will be automatically packed by npm.

Remove donation badges

Remove buy me a coffee and become a patron badges with donation text from README

Contribution guide modify

I want to point out that this readme is quite limiting because not all contributions have to be in the form of actual code, but also documentation, finding bugs, etc. Also I don't know about some of the steps:

1. git add --all. This is dependent on how extensive the .gitignore file is. I think it should say only add the actual files you purposely created or modified by having them check with git status first.
2. I think it would also be great if the doc included setting up an upstream from their local copy to this remote. ref https://akrabat.com/the-beginners-guide-to-contributing-to-a-github-project/.
3. This is a wonderful example of a contributing guide: https://github.com/ollelauribostrom/rebus

This should be opened in it's own issue though.

Originally posted by @cdrani in #62 (comment)

Add PR Template

Add PULL_REQUEST_TEMPLATE.md file with below content

Fixes #

release v1.0.5

Remove unused dependencies

Remove all unused dependencies,
I think for this we are only using mocha and chai as devDependencies for tests.
All other dependencies can be removed from package.json

replace npm with yarn in CONTRIBUTING.md

Run below command to verify all tests are passing
npm install (This will install all required dependencies)
npm test

I suppose this is meant to use yarn from the yarn.lock file.

Update README

Update readme with usage details and brief about library

Add Contributing file

Add CONTRIBUTING.md file and add the content something like this
https://raw.githubusercontent.com/arshadkazmi42/ak-cli/master/CONTRIBUTING.md

Add a new test

Add a test in test file, similar to this test
https://github.com/arshadkazmi42/ak-phrase.js/blob/master/test/generate_sentence_permutations.js#L16-L20

In the new test
const wordLists = [] needs to be changed to const wordLists = null

everything else will be same.

Pulish to NPM

Library needs to be published to NPM.

Release 1.0.4

Change Contributing.md

Change Contributing.md file to something like this

https://github.com/arshadkazmi42/custom-date-formatting/blob/master/CONTRIBUTING.md

Add repo size badge

[![Github Repo Size](https://img.shields.io/github/repo-size/arshadkazmi42/ak-phrase.js.svg)](https://github.com/arshadkazmi42/ak-phrase.js)

Add the above line in readme with other badges

Add contributors badge

Add below code with other badges code in README

[![Contributors](https://img.shields.io/github/contributors/arshadkazmi42/ak-phrase.js.svg)](https://github.com/arshadkazmi42/ak-phrase.js/graphs/contributors)