diff --git a/.cspell.json b/.cspell.json new file mode 100644 index 0000000..f1edca1 --- /dev/null +++ b/.cspell.json @@ -0,0 +1,15 @@ +{ + "version": "0.2", + "words": [ + "asynciterable", + "autobuild", + "codeql", + "devel", + "esbuild", + "linebreak", + "npmignore", + "outfile", + "postpublish", + "tada" + ] +} diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml new file mode 100644 index 0000000..538f9f7 --- /dev/null +++ b/.github/workflows/codeql.yml @@ -0,0 +1,40 @@ +jobs: + analyze: + name: Analyze + permissions: + actions: read + contents: read + security-events: write + runs-on: ubuntu-latest + strategy: + fail-fast: false + matrix: + language: + - 'javascript' + steps: + - name: Checkout repository + uses: actions/checkout@v3 + with: + fetch-depth: 1 + - name: Initialize CodeQL + uses: github/codeql-action/init@v2 + with: + languages: ${{ matrix.language }} + - name: Autobuild + uses: github/codeql-action/autobuild@v2 + - name: Perform CodeQL Analysis + uses: github/codeql-action/analyze@v2 +name: CodeQL +on: + pull_request: + branches: + - devel + - main + - release + push: + branches: + - devel + - main + - release + schedule: + - cron: '19 13 * * 3' diff --git a/.gitignore b/.gitignore index f19a286..f520ade 100644 --- a/.gitignore +++ b/.gitignore @@ -1,7 +1,6 @@ **/*.d.ts **/*.js **/.nyc_output/ -**/.vscode/ **/coverage/ **/lib/ **/node_modules/ diff --git a/.vscode/extensions.json b/.vscode/extensions.json new file mode 100644 index 0000000..9d7f267 --- /dev/null +++ b/.vscode/extensions.json @@ -0,0 +1,11 @@ +{ + "recommendations": [ + "DavidAnson.vscode-markdownlint", + "EditorConfig.EditorConfig", + "bierner.markdown-emoji", + "christian-kohler.npm-intellisense", + "codezombiech.gitignore", + "kisstkondoros.vscode-codemetrics", + "streetsidesoftware.code-spell-checker" + ] +} diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..d34f434 --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,8 @@ +{ + "files.associations": { + "**/LICENSE": "plaintext", + }, + "files.exclude": { + "node_modules": true, + }, +} diff --git a/CHANGELOG.md b/CHANGELOG.md index 43be2ca..9a0f0df 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,29 @@ # ChangeLogs +## Version 1.0.11 + +- :green_heart: CI chore + - A Farewell to Travis + - CodeQL is installed + - links on CI status badges are related specific branches + - looser Node.js versions are specified + - open-pull-requests-limit is increased up to 16 + - workflows are separated +- :hear_no_evil: CONTRIBUTING.md is added to .npmignore +- :arrow_up: Packages for development are bumped + - `@types/chai` is bumped from 4.3.0 to 4.3.7 + - `@types/mocha` is bumped from 9.0.0 to 10.0.1 + - `@types/node` is bumped from 16.11.12 to 18.11.17 + - `@typescript-eslint/eslint-plugin` is bumped from 5.6.0 to 5.47.0 + - `@typescript-eslint/parser` is bumped from 5.6.0 to 5.47.0 + - `chai` is bumped from 4.3.4 to 4.3.7 + - `esbuild` is bumped from 0.14.2 to 0.16.10 + - `eslint` is bumped from 8.4.1 to 8.30.0 + - `mocha` is bumped from 9.1.3 to 10.2.0 + - `ts-node` is bumped from 10.4.0 to 10.9.1 + - `typescript` is bumped from 4.5.3 to 4.9.4 +- :pencil2: Typo on README.md is fixed + ## Version 1.0.10 - :wrench: 'clean' is made to be invoked after 'publish' diff --git a/README.md b/README.md index 63c179a..10ae5e2 100644 --- a/README.md +++ b/README.md @@ -6,11 +6,11 @@ ## CI Status -| Branches \ Targets | Build | Coverage | Example | -| ---- | ---- | ---- | ---- -| devel | [![GitHub CI (Build)][github-devel-build-image]][github-devel-build-url] | [![GitHub CI (Coverage)][github-devel-coverage-image]][github-devel-coverage-url] | [![GitHub CI (Example)][github-devel-example-image]][github-devel-example-url] | -| main | [![GitHub CI (Build)][github-main-build-image]][github-main-build-url] | [![GitHub CI (Coverage)][github-main-coverage-image]][github-main-coverage-url] | [![GitHub CI (Example)][github-main-example-image]][github-main-example-url] | -| release | [![GitHub CI (Build)][github-release-build-image]][github-release-build-url] | [![GitHub CI (Coverage)][github-release-coverage-image]][github-release-coverage-url] | [![GitHub CI (Example)][github-release-example-image]][github-release-example-url] | +| Branches \ Targets | Build | CodeQL | Coverage | Example | +| ---- | ---- | ---- | ---- | ---- +| devel | [![GitHub CI (Build)][github-devel-build-image]][github-devel-build-url] | [![GitHub CI (CodeQL)][github-devel-codeql-image]][github-devel-codeql-url] | [![GitHub CI (Coverage)][github-devel-coverage-image]][github-devel-coverage-url] | [![GitHub CI (Example)][github-devel-example-image]][github-devel-example-url] | +| main | [![GitHub CI (Build)][github-main-build-image]][github-main-build-url] | [![GitHub CI (CodeQL)][github-main-codeql-image]][github-main-codeql-url] | [![GitHub CI (Coverage)][github-main-coverage-image]][github-main-coverage-url] | [![GitHub CI (Example)][github-main-example-image]][github-main-example-url] | +| release | [![GitHub CI (Build)][github-release-build-image]][github-release-build-url] | [![GitHub CI (CodeQL)][github-release-codeql-image]][github-release-codeql-url] | [![GitHub CI (Coverage)][github-release-coverage-image]][github-release-coverage-url] | [![GitHub CI (Example)][github-release-example-image]][github-release-example-url] | ## Installation @@ -68,7 +68,7 @@ async function example(): Promise { example() ``` -## Lincense +## License The scripts and documentation in this project are released under the [BSD-3-Clause License](https://github.com/kei-g/async-iterable-queue/blob/main/LICENSE) @@ -84,18 +84,24 @@ Contributions are welcome! See [Contributor's Guide](https://github.com/kei-g/as [dependency-url]:https://npmjs.com/package/async-iterable-queue?activeTab=dependencies [github-devel-build-image]:https://github.com/kei-g/async-iterable-queue/actions/workflows/build.yml/badge.svg?branch=devel [github-devel-build-url]:https://github.com/kei-g/async-iterable-queue/actions/workflows/build.yml?query=branch%3Adevel +[github-devel-codeql-image]:https://github.com/kei-g/async-iterable-queue/actions/workflows/codeql.yml/badge.svg?branch=devel +[github-devel-codeql-url]:https://github.com/kei-g/async-iterable-queue/actions/workflows/codeql.yml?query=branch%3Adevel [github-devel-coverage-image]:https://github.com/kei-g/async-iterable-queue/actions/workflows/coverage.yml/badge.svg?branch=devel [github-devel-coverage-url]:https://github.com/kei-g/async-iterable-queue/actions/workflows/coverage.yml?query=branch%3Adevel [github-devel-example-image]:https://github.com/kei-g/async-iterable-queue/actions/workflows/example.yml/badge.svg?branch=devel [github-devel-example-url]:https://github.com/kei-g/async-iterable-queue/actions/workflows/example.yml?query=branch%3Adevel [github-main-build-image]:https://github.com/kei-g/async-iterable-queue/actions/workflows/build.yml/badge.svg?branch=main [github-main-build-url]:https://github.com/kei-g/async-iterable-queue/actions/workflows/build.yml?query=branch%3Amain +[github-main-codeql-image]:https://github.com/kei-g/async-iterable-queue/actions/workflows/codeql.yml/badge.svg?branch=main +[github-main-codeql-url]:https://github.com/kei-g/async-iterable-queue/actions/workflows/codeql.yml?query=branch%3Amain [github-main-coverage-image]:https://github.com/kei-g/async-iterable-queue/actions/workflows/coverage.yml/badge.svg?branch=main [github-main-coverage-url]:https://github.com/kei-g/async-iterable-queue/actions/workflows/coverage.yml?query=branch%3Amain [github-main-example-image]:https://github.com/kei-g/async-iterable-queue/actions/workflows/example.yml/badge.svg?branch=main [github-main-example-url]:https://github.com/kei-g/async-iterable-queue/actions/workflows/example.yml?query=branch%3Amain [github-release-build-image]:https://github.com/kei-g/async-iterable-queue/actions/workflows/build.yml/badge.svg?branch=release [github-release-build-url]:https://github.com/kei-g/async-iterable-queue/actions/workflows/build.yml?query=branch%3Arelease +[github-release-codeql-image]:https://github.com/kei-g/async-iterable-queue/actions/workflows/codeql.yml/badge.svg?branch=release +[github-release-codeql-url]:https://github.com/kei-g/async-iterable-queue/actions/workflows/codeql.yml?query=branch%3Arelease [github-release-coverage-image]:https://github.com/kei-g/async-iterable-queue/actions/workflows/coverage.yml/badge.svg?branch=release [github-release-coverage-url]:https://github.com/kei-g/async-iterable-queue/actions/workflows/coverage.yml?query=branch%3Arelease [github-release-example-image]:https://github.com/kei-g/async-iterable-queue/actions/workflows/example.yml/badge.svg?branch=release