Skip to content

Commit

Permalink
fix: editorconfig version, remove outdated, update readme (#82)
Browse files Browse the repository at this point in the history
* fix: editorconfig version, remove outdated, update readme

* fix: add git init to readme for husky integration

* fix: bump ec checker version

* docs: remove reference to updated linter
  • Loading branch information
stepmr authored Apr 9, 2020
1 parent 46d9d8c commit 51b358f
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 5 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,6 @@ This NPM library initializer is a CLI tool that makes the process of creating an
- Automated version management and NPM package publishing using [semantic-release][semantic-release], that uses formalized commit message convention to document changes in the codebase
- Basic setup for unit tests with [tap][tap]
- Security auditing using [npm audit][npm-audit]
- Dependencies auditing using [updated][updated], and a command to automatically install updates
- `.editorconfig` linting using [editorconfig-checker][editorconfig]
- Javascript linting using [telus-standard][telus-standard], and a command to automatically fix most small issues
- Markdown linting for your README files using [remark-cli][remark-cli], and a command to automatically fix most small issues
Expand All @@ -59,12 +58,17 @@ Some of the tools mentioned above rely on centralized configuration files, that
mkdir my-new-project
cd my-new-project
npm init @telus/library
git init
npm install
```

or (automatically creates directory)

```bash
npm init @telus/library my-new-project
cd my-new-project
git init
npm install
```

When you run `npm init @telus/library`, you will be prompted with a few questions. Here's what you need to know to be ready:
Expand Down Expand Up @@ -141,7 +145,6 @@ Configure `babel` and your build script(s) as needed. Then consider the followin
Probably because the `lint` job fails! There are a few kinds of linting we have included with this template, and you should expect some of these to occasionally fail even if you didn't make any changes to the code. Here's why:

- We are linting for security vulnerabilities using `npm audit`. The dependencies you use might be ok today, but not tomorrow if a security issue is discovered!
- We are linting for outdated dependencies, because we believe this will encourage our devs to keep their apps dependencies up-to-date! The more dependencies you have, the higher the likelihood for those to be updated and hence cause your pipeline to fail. Refer to the [updated][updated] docs for more details and usage options.

### 5. Why doesn't the version inside `package.json` get updated?

Expand Down Expand Up @@ -169,7 +172,6 @@ Before you start using this initializer and the tools inside it, **please make s
[semantic-release]: https://github.com/semantic-release/semantic-release
[tap]: https://github.com/tapjs/node-tap
[npm-audit]: https://docs.npmjs.com/cli/audit
[updated]: https://github.com/ahmadnassri/node-updated
[editorconfig]: https://github.com/editorconfig-checker/editorconfig-checker.javascript
[telus-standard]: https://github.com/telus/telus-standard
[remark-cli]: https://github.com/remarkjs/remark/tree/master/packages/remark-cli
Expand Down
3 changes: 1 addition & 2 deletions template/package
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@
"scripts": {
"coverage": "opener coverage/lcov-report/index.html",
"lint:audit": "npm audit",
"lint:deps": "npx updated",
"lint:ec": "editorconfig-checker .",
"lint:js": "telus-standard --verbose",
"lint:md": "npx remark-cli --quiet --frail .",
Expand All @@ -44,6 +43,6 @@
"editorconfig-checker": "^2.2.0",
"husky": "^4.2.3",
"lint-staged": "^10.1.2",
"tap": "^14.10.17"
"tap": "^14.10.7"
}
}

0 comments on commit 51b358f

Please sign in to comment.