create-node-lib 2.5.1 → 2.7.0

package/.github/CODEOWNERS

@@ -0,0 +1 @@
+*   @lirantal

package/.github/workflows/main.yml

@@ -7,12 +7,12 @@ jobs:
   #   name: Lint
   #   runs-on: 'ubuntu-latest'
   #   steps:
-  #     - uses: actions/checkout@v2
-  #     - uses: actions/setup-node@v2
+  #     - uses: actions/checkout@v3
+  #     - uses: actions/setup-node@v3
   #       with:
-  #         node-version: '16'
+  #         node-version: '18'
   #     - name: install dependencies
-  #       run: npm ci
+  #       run: npm ci --audit false
   #     - name: lint code
   #       run: npm run lint
 
@@ -20,22 +20,22 @@ jobs:
     strategy:
       matrix:
         platform: [ubuntu-latest]
-        node: ['14', '16']
+        node: ['16', '18']
     name: Tests - Node ${{ matrix.node }} (${{ matrix.platform }})
     runs-on: ${{ matrix.platform }}
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v2
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node }}
       - name: install dependencies
-        run: npm ci --ignore-engines
+        run: npm ci --ignore-engines --audit false
       - name: run tests
         run: npm run test
-      - name: code coverage report
-        run: npx codecov
-        env:
-          CODECOV_TOKEN: ${{secrets.CODECOV_TOKEN}}
+      # - name: code coverage report
+      #   run: npx codecov
+      #   env:
+      #     CODECOV_TOKEN: ${{secrets.CODECOV_TOKEN}}
 
   release:
     name: do semantic release
@@ -43,12 +43,12 @@ jobs:
     needs: build
     if: github.event_name == 'push' && github.ref == 'refs/heads/main'
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v2
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
         with:
-          node-version: '16'
+          node-version: '18'
       - name: install dependencies
-        run: npm ci --ignore-engines --only=production
+        run: npm ci --ignore-engines --only=production --audit false
       - name: release
         run: npx semantic-release
         env:

package/__tests__/generator.test.js

@@ -8,10 +8,12 @@ describe('all the template files are accountable for', () => {
     jest.setTimeout(15000)
     const stream = await sao.mock({ generator: template })
     expect(stream.fileList).toContain('.github/ISSUE_TEMPLATE.md')
-    expect(stream.fileList).toContain('.github/ISSUE_TEMPLATE/1-bug-report.md')
-    expect(stream.fileList).toContain('.github/ISSUE_TEMPLATE/2-feature-request.md')
+    expect(stream.fileList).toContain('.github/ISSUE_TEMPLATE/1-bug-report.yml')
+    expect(stream.fileList).toContain('.github/ISSUE_TEMPLATE/2-feature-request.yml')
     expect(stream.fileList).toContain('.github/ISSUE_TEMPLATE/3-help.md')
     expect(stream.fileList).toContain('.github/PULL_REQUEST_TEMPLATE.md')
+    expect(stream.fileList).toContain('.github/CODE_OF_CONDUCT.md')
+    expect(stream.fileList).toContain('.github/CONTRIBUTING.md')
   })
 
   test('generator contains project files', async () => {
@@ -26,12 +28,10 @@ describe('all the template files are accountable for', () => {
     expect(stream.fileList).toContain('.gitignore')
     expect(stream.fileList).toContain('.prettierignore')
     expect(stream.fileList).toContain('.prettierrc.json')
-    expect(stream.fileList).toContain('.github/workflows/main.yml')
-    expect(stream.fileList).toContain('CODE_OF_CONDUCT.md')
-    expect(stream.fileList).toContain('CONTRIBUTING.md')
+    expect(stream.fileList).toContain('.github/workflows/ci.yml')
     expect(stream.fileList).toContain('LICENSE')
     expect(stream.fileList).toContain('README.md')
-    expect(stream.fileList).toContain('__tests__/app.test.js')
+    expect(stream.fileList).toContain('__tests__/app.test.ts')
     expect(stream.fileList).toContain('package.json')
   })
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-node-lib",
-  "version": "2.5.1",
+  "version": "2.7.0",
   "description": "Scaffolding out a Node.js library module",
   "bin": "./bin/cli.js",
   "engines": {
@@ -43,36 +43,36 @@
   },
   "dependencies": {
     "sao": "^1.7.1",
-    "validate-npm-package-name": "^3.0.0"
+    "validate-npm-package-name": "^5.0.0"
   },
   "devDependencies": {
-    "@commitlint/cli": "^9.1.2",
-    "@commitlint/config-conventional": "^7.1.2",
-    "@semantic-release/changelog": "^3.0.4",
-    "@semantic-release/commit-analyzer": "^6.2.0",
-    "@semantic-release/git": "^7.0.16",
-    "@semantic-release/github": "^5.4.2",
-    "@semantic-release/npm": "^7.1.0",
-    "@semantic-release/release-notes-generator": "^7.2.1",
+    "@commitlint/cli": "^17.4.2",
+    "@commitlint/config-conventional": "^17.4.2",
+    "@semantic-release/changelog": "^6.0.2",
+    "@semantic-release/commit-analyzer": "^9.0.2",
+    "@semantic-release/git": "^10.0.1",
+    "@semantic-release/github": "^8.0.7",
+    "@semantic-release/npm": "^9.0.2",
+    "@semantic-release/release-notes-generator": "^10.0.3",
     "babel-eslint": "^10.0.1",
     "babel-plugin-syntax-async-functions": "^6.13.0",
     "babel-plugin-transform-regenerator": "^6.26.0",
-    "babel-preset-env": "^1.6.1",
+    "babel-preset-env": "^1.7.0",
     "decompress": "^4.2.1",
-    "eslint": "^6.0.1",
-    "eslint-config-standard": "^13.0.1",
-    "eslint-plugin-import": "^2.18.0",
-    "eslint-plugin-jest": "^22.7.2",
-    "eslint-plugin-node": "^9.1.0",
-    "eslint-plugin-promise": "^4.2.1",
-    "eslint-plugin-security": "^1.4.0",
-    "eslint-plugin-standard": "^4.0.0",
-    "husky": "^3.0.0",
-    "jest": "^24.8.0",
-    "lint-staged": "^9.2.0",
-    "lockfile-lint": "^2.0.1",
-    "open-cli": "^6.0.0",
-    "prettier": "^1.18.2"
+    "eslint": "^8.33.0",
+    "eslint-config-standard": "^17.0.0",
+    "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-jest": "^27.2.1",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-promise": "^6.1.1",
+    "eslint-plugin-security": "^1.7.1",
+    "eslint-plugin-standard": "^4.1.0",
+    "husky": "^8.0.3",
+    "jest": "^29.4.1",
+    "lint-staged": "^13.1.0",
+    "lockfile-lint": "^4.10.0",
+    "open-cli": "^7.1.0",
+    "prettier": "^2.8.3"
   },
   "jest": {
     "testEnvironment": "node",
@@ -81,10 +81,10 @@
     "collectCoverage": true,
     "coverageThreshold": {
       "global": {
-        "branches": 70,
-        "functions": 70,
-        "lines": 70,
-        "statements": 70
+        "branches": 50,
+        "functions": 50,
+        "lines": 50,
+        "statements": 50
       }
     },
     "testPathIgnorePatterns": [
@@ -214,5 +214,8 @@
       }
     ],
     "@semantic-release/github"
-  ]
+  ],
+  "peerDependencies": {
+    "node-notifier": "^10.0.1"
+  }
 }

package/saofile.js

@@ -6,7 +6,10 @@ const SUPPORTED_NPM_CLIENTS = ['npm', 'yarn']
 module.exports = {
   description: 'Scaffolding out a node library.',
   templateData: {
-    year: new Date().getFullYear()
+    year: new Date().getFullYear(),
+    npmClientInstall: ({ npmClient }) => {
+      return npmClient === 'npm' ? 'install' : 'add'
+    }
   },
   prompts() {
     return [
@@ -30,12 +33,12 @@ module.exports = {
       {
         name: 'description',
         message: 'How would you describe the new project',
-        default: ``
+        default: ''
       },
       {
         name: 'keywords',
         message: 'Comma-separated list of package keywords for npm',
-        default: ``
+        default: ''
       },
       {
         name: 'author',
@@ -90,22 +93,15 @@ module.exports = {
           ] = `lockfile-lint --path ${lockfile} --validate-https --allowed-hosts npm yarn`
           return data
         }
-      },
-      {
-        type: 'modify',
-        files: 'package.json',
-        handler(data, filepath) {
-          data.files = ['src']
-          return data
-        }
-      },
-      {
-        type: 'move',
-        patterns: {
-          gitignore: '.gitignore'
-          // '_package.json': 'package.json'
-        }
       }
+      // we already have the .gitignore file as part of the template/ directory
+      // {
+      //   type: 'move',
+      //   patterns: {
+      //     gitignore: '.gitignore'
+      //     // '_package.json': 'package.json'
+      //   }
+      // }
     ]
   },
   async completed() {
@@ -113,6 +109,6 @@ module.exports = {
     await this.npmInstall({ npmClient: this.answers.npmClient })
     this.showProjectTips()
 
-    this.logger.tip(`You're all setup. hack away!`)
+    this.logger.tip('You\'re all setup. hack away!')
   }
 }

package/template/.github/.markdownlint.yml

@@ -0,0 +1,9 @@
+default: true
+
+# Line length - https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md013---line-length
+MD013:
+  code_blocks: false
+  tables: false
+
+# Do not enforce line length in markdown files
+line_length: false

package/template/.github/CODEOWNERS

@@ -0,0 +1 @@
+*       @<%= username %>

package/template/{CONTRIBUTING.md → .github/CONTRIBUTING.md}

@@ -2,14 +2,17 @@
 
 :+1::tada: First off, thanks for taking the time to contribute! :tada::+1:
 
-The following is a set of guidelines for contributing to <%= projectName %>.
-These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
+The following is a set of guidelines for contributing to this project.
+These are mostly guidelines, not rules. Use your best judgment, and feel free
+to propose changes to this document in a pull request.
 
 ## Code of Conduct
 
-This project and everyone participating in it is governed by a [Code of Conduct](./CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.
+This project and everyone participating in it is governed by a
+[Code of Conduct](./CODE_OF_CONDUCT.md). By participating, you are expected to
+uphold this code.
 
-## How to contribute to <%= projectName %>
+## How to contribute to this project
 
 <!-- TODO -->
 
@@ -25,4 +28,5 @@ npm run test
 
 ### Commit Guidelines
 
-The project uses the commitizen tool for standardizing changelog style commit and a git pre-commit hook to enforce them.
+The project uses the commitizen tool for standardizing changelog style commit
+and a git pre-commit hook to enforce them.

package/template/.github/ISSUE_TEMPLATE/1-bug-report.yml

@@ -0,0 +1,31 @@
+body:
+  - attributes:
+      description: If any of these required steps are not taken, we may not be able to review your issue. Help us to help you!
+      label: Bug Report Checklist
+      options:
+        - label: I have pulled the latest `main` branch of the repository.
+          required: true
+        - label: I have [searched for related issues](https://github.com/<%= username %>/<%= projectName %>/issues?q=is%3Aissue) and found none that matched my issue.
+          required: true
+    type: checkboxes
+  - attributes:
+      description: What did you expect to happen?
+      label: Expected
+    type: textarea
+    validations:
+      required: true
+  - attributes:
+      description: What happened instead?
+      label: Actual
+    type: textarea
+    validations:
+      required: true
+  - attributes:
+      description: Any additional info you'd like to provide.
+      label: Additional Info
+    type: textarea
+description: Report a bug trying to run the code
+labels:
+  - "type: bug"
+name: 🐛 Bug
+title: "🐛 Bug: <short description of the bug>"

package/template/.github/ISSUE_TEMPLATE/2-feature-request.yml

@@ -0,0 +1,23 @@
+body:
+  - attributes:
+      description: If any of these required steps are not taken, we may not be able to review your issue. Help us to help you!
+      label: Bug Report Checklist
+      options:
+        - label: I have pulled the latest `main` branch of the repository.
+          required: true
+    type: checkboxes
+  - attributes:
+      description: What did you expect to be able to do? Please describe the problem you are trying to solve.
+      label: Overview
+    type: textarea
+    validations:
+      required: true
+  - attributes:
+      description: Any additional info you'd like to provide.
+      label: Additional Info
+    type: textarea
+description: Request that a new feature be added or an existing feature improved
+labels:
+  - "type: feature"
+name: 🚀 Feature
+title: "🚀 Feature: <short description of the feature>"

package/template/.github/dependabot.yml

@@ -0,0 +1,38 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: ".github/workflows"
+    schedule:
+      interval: "monthly"
+    commit-message:
+      # Prefix all commit messages with "chore: "
+      prefix: "chore"
+    open-pull-requests-limit: 10
+
+  - package-ecosystem: "npm"
+    directory: "/"
+    commit-message:
+      # Prefix all commit messages with "chore: "
+      prefix: "chore"
+    schedule:
+      interval: "weekly"
+    open-pull-requests-limit: 10
+    groups:
+      # Production dependencies without breaking changes
+      dependencies:
+        dependency-type: "production"
+        update-types:
+        - "minor"
+        - "patch"
+      # Production dependencies with breaking changes
+      dependencies-major:
+        dependency-type: "production"
+        update-types:
+        - "major"
+      # Development dependencies
+      dev-dependencies:
+        dependency-type: "development"
+    # example for ignoring dependencies:
+    # ignore:
+    #   - dependency-name: tap
+    #     update-types: ["version-update:semver-major"]

package/template/.github/labeler.yml

@@ -0,0 +1,20 @@
+documentation:
+- changed-files:
+  - any-glob-to-any-file:
+    - "docs/*"
+    - "**/*.md"
+    - "guides/*"
+
+build:
+- changed-files:
+  - any-glob-to-any-file: ".github/workflows/*"
+
+typescript:
+- changed-files:
+  - any-glob-to-any-file: "**/*[.|-]d.ts"
+
+cli:
+- any: ["bin/**/*", "cli/**/*"]
+
+test:
+- any: ["test/**/*", "__tests__/**/*"]

package/template/.github/workflows/ci.yml

@@ -0,0 +1,49 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    strategy:
+      matrix:
+        node: ["18.x", "20.x", "22.0.0"]
+        platform: [ubuntu-latest]
+    name: Node v${{matrix.node}} ((${{matrix.platform}}))
+    runs-on: ${{matrix.platform}}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: ${{matrix.node}}
+      - name: install dependencies
+        run: npm ci
+      - name: lint code
+        run: npm run lint
+      - name: build project
+        run: npm run build
+      - name: run tests
+        run: npm run test
+      - name: coverage
+        uses: codecov/codecov-action@v4
+        if: github.actor != 'dependabot[bot]'
+        with:
+          fail_ci_if_error: true
+          verbose: false
+          token: ${{ secrets.CODECOV_TOKEN }}
+        env:
+          CI: true
+
+  release-preview:
+    runs-on: ubuntu-latest
+    needs: test
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: "22.0.0"
+      - name: install dependencies
+        run: npm ci
+      - name: build project
+        run: npm run build
+      - name: release preview with pkr-pr-new
+        run: npx pkg-pr-new publish

package/template/.github/workflows/labeler.yml

@@ -0,0 +1,12 @@
+name: "Pull Request Labeler"
+
+on: pull_request_target
+
+jobs:
+  label:
+    permissions:
+      contents: read
+      pull-requests: write
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/labeler@v5

package/template/.github/workflows/links-checker-schedule.yml

@@ -0,0 +1,28 @@
+name: Links Checker (On Schedule)
+
+on:
+  repository_dispatch:
+  workflow_dispatch:
+  schedule:
+    - cron: "00 18 * * *"
+
+jobs:
+  linkChecker:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repo
+        uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+
+      - name: Link Checker
+        id: lychee
+        uses: lycheeverse/lychee-action@2b973e86fc7b1f6b36a93795fe2c9c6ae1118621 # v1.10.0
+
+      - name: Create Issue From File
+        if: env.lychee_exit_code != 0
+        uses: peter-evans/create-issue-from-file@24452a72d85239eacf1468b0f1982a9f3fec4c94 # v5.0.0
+        with:
+          title: Link Checker Report
+          content-filepath: ./lychee/out.md
+          labels: report, automated issue

package/template/.github/workflows/lock-threads.yml

@@ -0,0 +1,34 @@
+---
+name: stale
+
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: "9 9 * * *"
+
+permissions:
+  issues: write
+  pull-requests: write
+
+jobs:
+  stale:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/stale@28ca1036281a5e5922ead5184a1bbf96e5fc984e # v9.0.0
+        with:
+          close-issue-message: |
+            This issue has not seen any activity since it was marked stale.
+            Closing.
+          close-pr-message: |
+            This pull request has not seen any activity since it was marked stale.
+            Closing.
+          exempt-issue-labels: good-first-issue,need-help,no-stale,pinned,security
+          exempt-pr-labels: "autorelease: pending,good-first-issue,need-help,no-stale,pinned,security"
+          stale-issue-label: stale
+          stale-issue-message: |
+            This issue is stale because it has been open 60 days with no activity.
+            Remove stale label or comment or this will be closed in 7 days
+          stale-pr-label: stale
+          stale-pr-message: |
+            This PR is stale because it has been open 60 days with no activity.
+            Remove stale label or comment or this will be closed in 7 days.

package/template/.github/workflows/markdown-lint.yml

@@ -0,0 +1,26 @@
+name: Markdown Lint
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  markdown_lint:
+    name: Lint Markdown files
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Markdown Lint
+        uses: ruzickap/action-my-markdown-linter@26b4129bf0352527e60b5bd739357af63df1b7bf
+        with:
+          debug: true
+          config_file: .github/.markdownlint.yml
+          exclude: |
+            .changeset/
+            .github/
+            CODE_OF_CONDUCT.md
+            LICENSE
+            CHANGELOG.md

package/template/.github/workflows/release.yml

@@ -0,0 +1,38 @@
+name: release
+
+on:
+  push:
+    branches:
+      - main
+
+concurrency: ${{ github.workflow }}-${{ github.ref }}
+
+jobs:
+  release:
+    permissions:
+      contents: write       # to create release (changesets/action)
+      issues: write         # to post issue comments (changesets/action)
+      pull-requests: write  # to create pull request (changesets/action)
+      id-token: write       # to create release (changesets/action)
+      packages: write       # to publish to npm (changesets/action)
+    timeout-minutes: 20
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20.x
+      - name: install dependencies
+        run: npm ci
+      - name: build project
+        run: npm run build
+      - name: Create Release Pull Request or Publish to npm
+        uses: changesets/action@v1
+        with:
+          publish: npm run release
+          version: npm run version
+          commit: "chore: new release"
+          title: "chore: new release candidate"
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

package/template/.husky/commit-msg

@@ -1,4 +1,4 @@
 #!/bin/sh
 . "$(dirname "$0")/_/husky.sh"
 
-npx --no-install commitlint --edit ""
+npx --no validate-conventional-commit < .git/COMMIT_EDITMSG

package/template/README.md

@@ -1,4 +1,4 @@
-<% const npmClientInstall = context.npmClient === 'npm' ? 'install --save' : 'add' -%>
+<!-- markdownlint-disable -->
 
 <p align="center"><h1 align="center">
   <%= projectName %>
@@ -18,31 +18,22 @@
   <a href="./SECURITY.md"><img src="https://img.shields.io/badge/Security-Responsible%20Disclosure-yellow.svg" alt="Responsible Disclosure Policy" /></a>
 </p>
 
-# About
-
-<%= description %>
-
-# Install
+## Install
 
 ```bash
 <%= npmClient %> <%= npmClientInstall %> <%= projectName %>
 ```
+## Usage: CLI
 
-# Usage
-
-```js
+```bash
 // @TODO
 const {} = require('<%= projectName %>')
 ```
 
-# Example
-
-<!-- TODO -->
-
-# Contributing
+## Contributing
 
-Please consult [CONTRIBUTING](./CONTRIBUTING.md) for guidelines on contributing to this project.
+Please consult [CONTRIBUTING](./.github/CONTRIBUTING.md) for guidelines on contributing to this project.
 
-# Author
+## Author
 
-**<%= projectName %>** © [<%= author %>](https://github.com/<%= username %>), Released under the [Apache-2.0](./LICENSE) License.
+**<%= projectName %>** © [<%= author %>](https://github.com/<%= username %>), Released under the [Apache-2.0](./LICENSE) License.