Add list command flag details in help

Add a contributing guide

While running tests, some dummy commands are generated and stored in the config.
Let's modify the tests to remove those dummy squashed commands once all tests are completed

Publish this library to npm once its ready.

Remove all commented code from this test file
https://github.com/arshadkazmi42/squash/blob/master/tests/test.js

Depends on #31

Replace Contributors information in README with the below code

<a href="https://github.com/arshadkazmi42"><img src="https://github.com/arshadkazmi42.png" width="30" /></a><a href="https://github.com/ArthurCueio"><img src="https://github.com/ArthurCueio.png" width="30" /></a><a href="https://github.com/Zandew"><img src="https://github.com/Zandew.png" width="30" /></a><a href="https://github.com/co16353sidak"><img src="https://github.com/co16353sidak.png" width="30" /></a><a href="https://github.com/samuelweekes"><img src="https://github.com/samuelweekes.png" width="30" /></a><a href="https://github.com/alexmarginean16"><img src="https://github.com/alexmarginean16.png" width="30" /></a><a href="https://github.com/Aneal-Sharma"><img src="https://github.com/Aneal-Sharma.png" width="30" /></a><a href="https://github.com/konstunn"><img src="https://github.com/konstunn.png" width="30" /></a><a href="https://github.com/mzmmlds"><img src="https://github.com/mzmmlds.png" width="30" /></a><a href="https://github.com/fathurifki"><img src="https://github.com/fathurifki.png" width="30" /></a>

The current /usr/local/.squash folder requires root privileges. Forcing the user to run squash as root (sudo). Alternatively we could use:

• ~/.local/bin
  or
• ~/bin

Both of these won't need root permissions in order to create/delete files. Some side effects would be:

• No need to manually export $PATH as both of the above paths are alredy exported by default.
• The user wouldn't have to run squash as root. (Changes in #74 can be reverted after this)
• Squashed commands would become user-wide instead of the current system-wide.

To change this all we need is change the following line:

Let's add some colors to terminal messages

This PR should be made against the 2.0 dev branch

Change from flags to subcommands, right now complete squash works on flags.
We should change it into subcommands
squash --list
should be
squash list

This PR should be made against the 2.0 dev branch

This could be done by adding "$@" after the command in the sh file.

Let's create some gifs to showcase demo of using all types of flags in squash

• alias #78
• list #103
• system-alias #103
• rm #103
• help #103
• pass-args #103
• version #103

squash --list shows list of all created alias.
Let's add a feature to remove any existing alias by giving a rm flag

squash --r show-home

Need to add edit sh script option using squash

There are some cool features that require a MAJOR update. I'll keep updating this list until we have enough to make a release.

• #85 Change root dir to avoid manual export. (For this we need changes in the --list flag)
• #95 Change from flags to subcommands? ( squash --list => squash list )
• #94 Add terminal colors

I think it would be good to have a 2.0 development branch so we can start developing a better version and still push out fixes for 1.x

Validate if its system level command alias

All the below issues needs to be fixed for this release

• #66 (Moved to #88 )
• #75
• #77

Make the generated sh (generated in #3 ) files executable

Write a good readme for the project

Issues to fixed

• #59
• #47
• #44

Add unit tests to test the library and also integrated TRAVIS.CI for continuous integration testing

Now all our tests are running by travis ci, there is no need to keep two separate test files.
Let's merge test/tests.js and test/local.js files

On using --pass-args flag while squashing commands, --pass-args is taken as name if we place it after the --alias flag.

squash ls --alias=list --pass-args

But if you use it like

squash ls --pass-args --alias-list

it works fine for this.

It should not matter by position of the flag to pick the filename. It should process everything based on the flags

At present code is not structured properly.
Need to work on some cleanup and structuring the code properly.

Need to add a handler, to check if alias already in use.

Change --system_alias flag to --system-alias

We need a better way to keep track squashed commands. In order to change the root dir to a place we don't need to manually export (#85). The current version will try to list all files inside the squash directory.

This PR should be made against the 2.0 dev branch

Change PULL_REQUEST_TEMPLATE.md file content to below content

Fixes #issuenumber

Check everything which applies

- [ ] I have added the issue number for which this pull request is created.

Add flag for listing all existing commands

Add pull request template.
Create a file name PULL_REQUEST_TEMPLATE.md in root directory

and add the following in it

Fixes #issuenumber

Check everything which applies
[] I have added the issue number for which this pull request is created.

Add detail of system_alias flag in readme

Fix type you -> your

Add contributors avatar in README.md

Add the below code at the end of the README

## Contributors
[![](https://sourcerer.io/fame/arshadkazmi42/arshadkazmi42/squash/images/0)](https://sourcerer.io/fame/arshadkazmi42/arshadkazmi42/squash/links/0)[![](https://sourcerer.io/fame/arshadkazmi42/arshadkazmi42/squash/images/1)](https://sourcerer.io/fame/arshadkazmi42/arshadkazmi42/squash/links/1)[![](https://sourcerer.io/fame/arshadkazmi42/arshadkazmi42/squash/images/2)](https://sourcerer.io/fame/arshadkazmi42/arshadkazmi42/squash/links/2)[![](https://sourcerer.io/fame/arshadkazmi42/arshadkazmi42/squash/images/3)](https://sourcerer.io/fame/arshadkazmi42/arshadkazmi42/squash/links/3)[![](https://sourcerer.io/fame/arshadkazmi42/arshadkazmi42/squash/images/4)](https://sourcerer.io/fame/arshadkazmi42/arshadkazmi42/squash/links/4)[![](https://sourcerer.io/fame/arshadkazmi42/arshadkazmi42/squash/images/5)](https://sourcerer.io/fame/arshadkazmi42/arshadkazmi42/squash/links/5)[![](https://sourcerer.io/fame/arshadkazmi42/arshadkazmi42/squash/images/6)](https://sourcerer.io/fame/arshadkazmi42/arshadkazmi42/squash/links/6)[![](https://sourcerer.io/fame/arshadkazmi42/arshadkazmi42/squash/images/7)](https://sourcerer.io/fame/arshadkazmi42/arshadkazmi42/squash/links/7)

I'm trying to remove a squashed command, but it displays this error.

Also should update readme to say --rm= instead of just --rm? had to look around for a while to find this.

[![Node Version](https://img.shields.io/badge/node-v8.0%2B-brightgreen.svg)](https://github.com/arshadkazmi42/squash/)

Add it below title with other badges in readme

This would help prevent bugs like #69 from getting pushed to the master branch

Somehow package.json has got alot of dependencies which are not even getting used.
package.json dependencies needs to be cleaned up

Parse commands and input arguments

Add --version flag, which should returns the version of installed version of squash

Storing parsed commands in sh files which can be executed from anywhere in the system

• #66
• #91

Installing squash by following the given steps in the tutorial,
when I try to add an alias for a command it throws an error, linking the screenshot below.

it tries to create a local/.squash file but finds it already there.
Is this error specific to my system or something which could be fixed.

OS: MacOS 10.14.3

Right now squash is Unlicesnsed.
I think we should add MIT license to this.

After installing with npm and running squash I have the following error

konstunn@asus:~ (master)$ squash
/usr/local/lib/node_modules/ak-squash/index.js:6
const [, , ...args] = process.argv;
      ^

SyntaxError: Unexpected token [
    at exports.runInThisContext (vm.js:53:16)
    at Module._compile (module.js:374:25)
    at Object.Module._extensions..js (module.js:417:10)
    at Module.load (module.js:344:32)
    at Function.Module._load (module.js:301:12)
    at Function.Module.runMain (module.js:442:10)
    at startup (node.js:136:18)
    at node.js:966:3

Add command wraping in quotes in help section of squash

squash accepts commands wrap inside double quotes "COMMAND", its better to use quotes for commands having single quote or spaces.

This can be updated here https://github.com/arshadkazmi42/squash/blob/master/lib/util.js#L80-L97

Storing the sh details in some store, preferably a json.
It should be something like it can be accessed and edited later.

Store is open for discussion, we can use something else also other than json. We can discuss more on this if required

Add eslint config.