From 6b31c9566f76cbcda3c52e155c89d5320faaccff Mon Sep 17 00:00:00 2001 From: stepmr Date: Tue, 7 Apr 2020 14:36:17 -0700 Subject: [PATCH 1/4] fix: editorconfig version, remove outdated, update readme --- README.md | 8 +++++--- package.json | 2 +- template/package | 5 ++--- 3 files changed, 8 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 43b8ac8..52cc80b 100644 --- a/README.md +++ b/README.md @@ -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 @@ -58,6 +57,7 @@ Some of the tools mentioned above rely on centralized configuration files, that ```bash mkdir my-new-project cd my-new-project +git init npm init @telus/library ``` @@ -65,6 +65,9 @@ or (automatically creates directory) ```bash npm init @telus/library my-new-project +cd my-new-project +git init +npm init @telus/library ``` 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: @@ -141,7 +144,7 @@ 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. +- 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. ### 5. Why doesn't the version inside `package.json` get updated? @@ -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 diff --git a/package.json b/package.json index d062b68..4bdaccb 100644 --- a/package.json +++ b/package.json @@ -54,7 +54,7 @@ "@telus/prettier-config": "^1.0.3", "@telus/remark-config": "^1.2.0", "@telus/telus-standard": "^2.0.3", - "editorconfig-checker": "^2.2.0", + "editorconfig-checker": "^1.3.0", "husky": "^4.2.3", "lint-staged": "^10.1.2" }, diff --git a/template/package b/template/package index b0df38e..e1af480 100644 --- a/template/package +++ b/template/package @@ -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 .", @@ -41,9 +40,9 @@ "@telus/prettier-config": "^1.0.3", "@telus/telus-standard": "^2.0.3", "@telus/remark-config": "^1.2.0", - "editorconfig-checker": "^2.2.0", + "editorconfig-checker": "^1.3.0", "husky": "^4.2.3", "lint-staged": "^10.1.2", - "tap": "^14.10.17" + "tap": "^14.10.7" } } From 87efd78dd0ee57a27f431995cb6d94036e4a006d Mon Sep 17 00:00:00 2001 From: stepmr Date: Tue, 7 Apr 2020 23:04:11 -0700 Subject: [PATCH 2/4] fix: add git init to readme for husky integration --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 52cc80b..60214b1 100644 --- a/README.md +++ b/README.md @@ -57,8 +57,9 @@ Some of the tools mentioned above rely on centralized configuration files, that ```bash mkdir my-new-project cd my-new-project -git init npm init @telus/library +git init +npm install ``` or (automatically creates directory) @@ -67,7 +68,7 @@ or (automatically creates directory) npm init @telus/library my-new-project cd my-new-project git init -npm init @telus/library +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: From cea3d7023715b2787d6cb11fc4af00c61b67a856 Mon Sep 17 00:00:00 2001 From: stepmr Date: Wed, 8 Apr 2020 22:29:54 -0700 Subject: [PATCH 3/4] fix: bump ec checker version --- package.json | 2 +- template/package | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 4bdaccb..d062b68 100644 --- a/package.json +++ b/package.json @@ -54,7 +54,7 @@ "@telus/prettier-config": "^1.0.3", "@telus/remark-config": "^1.2.0", "@telus/telus-standard": "^2.0.3", - "editorconfig-checker": "^1.3.0", + "editorconfig-checker": "^2.2.0", "husky": "^4.2.3", "lint-staged": "^10.1.2" }, diff --git a/template/package b/template/package index e1af480..3b0551a 100644 --- a/template/package +++ b/template/package @@ -40,7 +40,7 @@ "@telus/prettier-config": "^1.0.3", "@telus/telus-standard": "^2.0.3", "@telus/remark-config": "^1.2.0", - "editorconfig-checker": "^1.3.0", + "editorconfig-checker": "^2.2.0", "husky": "^4.2.3", "lint-staged": "^10.1.2", "tap": "^14.10.7" From fc037adefa640efd9eb5580164acf79130d4b08a Mon Sep 17 00:00:00 2001 From: stepmr Date: Wed, 8 Apr 2020 22:34:14 -0700 Subject: [PATCH 4/4] docs: remove reference to updated linter --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index 60214b1..79fa3dc 100644 --- a/README.md +++ b/README.md @@ -145,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. ### 5. Why doesn't the version inside `package.json` get updated?