Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ on:
pull_request:
push:
branches:
- master
- main
- develop

jobs:
Expand All @@ -20,8 +20,8 @@ jobs:
node-version: '14'
check-latest: true

- name: Install
run: yarn install
- name: Install dependencies
run: npm ci

- name: Test
run: yarn test
run: npm run test
2 changes: 0 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,3 @@ node_modules/
dist/
coverage/
npm-debug.log
yarn-error.log
package-lock.json
3 changes: 1 addition & 2 deletions .huskyrc
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
{
"hooks": {
"pre-commit": "yarn test",
"pre-push": "yarn test"
"pre-commit": "npm test"
}
}
2 changes: 1 addition & 1 deletion .nvmrc
Original file line number Diff line number Diff line change
@@ -1 +1 @@
12.16.2
14.15.5
4 changes: 2 additions & 2 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
language: node_js
branches:
only:
- master
- main
cache:
yarn: true
npm: true
8 changes: 0 additions & 8 deletions .yarnrc

This file was deleted.

22 changes: 8 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,37 +22,31 @@ Using npm:
$ npm install nested-sort
```

Using yarn:
```shell
$ yarn add nested-sort
```

## Contribution

### Developer environment requirements

To run this project, you will need:

- Node.js >= v10.5.0, use nvm - [install instructions](https://github.com/creationix/nvm#install-script)
- Yarn >= v1.7.0 - [install instructions ("Alternatives" tab)](https://yarnpkg.com/en/docs/install#alternatives-rc)
- Node.js >= v14.15.5, use nvm - [install instructions](https://github.com/creationix/nvm#install-script)
- NPM >= v7.22.0

### Running tests

```sh
yarn
yarn test
yarn test --watch
yarn test:coverage
npm run test
npm run test:coverage
npm run test:watch
```

### Dev mode

When developing you can run:

```
yarn watch
npm run watch
```

This will regenerate the build files each time a source file is changed and serve on http://127.0.0.1:5000.
This will regenerate the build files each time a source file is changed and serve on http://127.0.0.1:3000.

You can navigate to http://127.0.0.1:5000/dev/ in order to see the samples.
You can navigate to http://127.0.0.1:3000/dev/ in order to see the samples.
Loading