create-node-lib 2.6.0 → 2.7.0

package/.github/workflows/main.yml

@@ -32,10 +32,10 @@ jobs:
         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

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.6.0",
+  "version": "2.7.0",
   "description": "Scaffolding out a Node.js library module",
   "bin": "./bin/cli.js",
   "engines": {
@@ -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": [

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,14 +93,15 @@ module.exports = {
           ] = `lockfile-lint --path ${lockfile} --validate-https --allowed-hosts npm yarn`
           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() {
@@ -105,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.

package/template/RELEASE.md

@@ -0,0 +1,42 @@
+# Managing Package Releases
+
+This project uses the [Changesets](https://github.com/changesets/changesets)
+tool to manage semantic versioning and release notes.
+
+## Pre-requisites
+
+Permit GitHub Actions to create and approve pull requests:
+
+1. Go to Actions -> General in the repository settings: (`https://github.com/<user>/<repo>/settings/actions`)
+2. In `Workflow permissions` enable the toggle for
+`Allow GitHub Actions to create and approve pull requests` (it is not required
+to also toggle the `Read and write permission` option)
+
+## How to release a new version of the package
+
+### Step 1: Create a new changeset
+
+```sh
+npx changeset
+```
+
+Follow the prompt to choose the major/minor/patch version and affected
+packages (if a monorepo).
+
+### Step 2: Commit the changeset file(s) to the repository
+
+```sh
+git add .changeset/
+git commit -m "chore: add changeset for release"
+git push origin HEAD
+```
+
+### Step 3: A new Pull Request for versioning
+
+The Changesets GitHub Action will pick up the new changeset in the repository
+and open a new pull request with the versioning changes in the relevant package
+manifest files. Review the changes and merge the pull request.
+
+### Step 4: Publish the package
+
+The GitHub Action will automatically publish the package to the npm registry.

package/template/SECURITY.md

@@ -4,16 +4,25 @@
 
 ## Responsible disclosure security policy
 
-A responsible disclosure policy helps protect users of the project from public disclosure of security vulnerabilities without a fix available. We achieve that by following the process where vulnerabilities are first triaged in a private manner, and are only publicly disclosed after a reasonable time period of the patch being available for users.
+A responsible disclosure policy helps protect users of the project from public
+disclosure of security vulnerabilities without a fix available. We achieve
+that by following the process where vulnerabilities are first triaged in a
+private manner, and are only publicly disclosed after a reasonable time period
+of the patch being available for users.
 
-We kindly ask you to refrain from malicious acts that put our users, the project, or any of the project’s team members at risk.
+We kindly ask you to refrain from malicious acts that put our users, the
+project, or any of the project’s team members at risk.
 
 ## Reporting a security issue
 
 We consider the security of the project a top priority.
 
-If you discover a security vulnerability, please use one of the following means of communications to report it to us:
+If you discover a security vulnerability, please use one of the following
+means of communications to report it to us:
 
-- Report the security issue to the [Snyk Security Team](https://snyk.io/vulnerability-disclosure). They will help triage the security issue and work with all involved parties to remediate and release a fix.
+- Report the security issue to the [Snyk Security Team](https://snyk.io/vulnerability-disclosure).
+- They will help triage the security issue and work with all involved parties
+- to remediate and release a fix.
 
-We sincerely appreciate your efforts to responsibly disclose your findings with us.
+We sincerely appreciate your efforts to responsibly disclose your findings
+with us.

package/template/__tests__/app.test.ts

@@ -0,0 +1,17 @@
+import { test, describe, beforeEach, mock } from 'node:test'
+import assert from 'node:assert'
+import { add } from '../src/main.ts'
+
+describe('CLI program', () => {
+
+  beforeEach(() => {
+    // Reset the mocks before each test
+    mock.reset()
+  });
+
+  test('Program sums two arguments', async (t) => {
+    const result = await add(1, 1);
+    assert.strictEqual(result, 2);
+  })
+
+});

package/template/eslint.config.js

@@ -0,0 +1,32 @@
+import pluginSecurity from 'eslint-plugin-security'
+import neostandard, { resolveIgnoresFromGitignore, plugins } from 'neostandard'
+
+export default [
+  ...neostandard({ ignores: resolveIgnoresFromGitignore() }),
+  plugins.n.configs['flat/recommended-script'],
+  pluginSecurity.configs.recommended,
+  {
+    rules: {
+      'no-process-exit': 'warn',
+      'node/no-unsupported-features': 'off',
+      'node/no-unpublished-require': 'off',
+      'security/detect-non-literal-fs-filename': 'error',
+      'security/detect-unsafe-regex': 'error',
+      'security/detect-buffer-noassert': 'error',
+      'security/detect-child-process': 'error',
+      'security/detect-disable-mustache-escape': 'error',
+      'security/detect-eval-with-expression': 'error',
+      'security/detect-no-csrf-before-method-override': 'error',
+      'security/detect-non-literal-regexp': 'error',
+      'security/detect-object-injection': 'warn',
+      'security/detect-possible-timing-attacks': 'error',
+      'security/detect-pseudoRandomBytes': 'error',
+      'space-before-function-paren': 'off',
+      'object-curly-spacing': 'off',
+    },
+    languageOptions: {
+      ecmaVersion: 2024,
+      sourceType: 'module',
+    },
+  },
+]

package/template/package.json

@@ -1,37 +1,57 @@
 {
   "name": "<%= projectName %>",
-  "version": "0.0.0-development",
+  "version": "0.0.1",
   "description": "<%= description %>",
-  "main": "main.js",
-  "bin": {
-    "cli": "bin/cli.js"
-  },
+  "types": "dist/main.d.ts",
+  "type": "module",
+  "bin": "./dist/bin/cli.cjs",
   "exports": {
-    ".": "./src/main.js"
+    ".": {
+      "import": {
+        "types": "./dist/main.d.ts",
+        "default": "./dist/main.mjs"
+      },
+      "require": {
+        "types": "./dist/main.d.cts",
+        "default": "./dist/main.cjs"
+      },
+      "default": "./dist/main.mjs"
+    },
+    "./dist/*": {
+      "types": "./dist/*.d.ts",
+      "import": "./dist/*.mjs",
+      "require": "./dist/*.cjs"
+    }
   },
   "engines": {
-    "node": ">=14.0.0"
+    "node": ">=20.0.0"
   },
-  "type": "module",
+  "packageManager": "npm@8.4.0",
   "files": [
+    "dist",
     "src",
     "bin"
   ],
   "scripts": {
-    "lint": "eslint . && <%= npmClient %> run lint:lockfile",
+    "build": "tsc && tsup",
+    "lint": "eslint . && npm run lint:lockfile",
     "lint:fix": "eslint . --fix",
-    "format": "prettier --config .prettierrc.json --write '**/*.js'",
-    "test": "NODE_OPTIONS=--experimental-vm-modules npx jest",
-    "test:watch": "NODE_OPTIONS=--experimental-vm-modules npx jest --watch",
-    "coverage:view": "open-cli coverage/lcov-report/index.html",
-    "semantic-release": "npx semantic-release",
-    "prepare": "husky install && chmod 755 .husky/*"
+    "lint:lockfile": "lockfile-lint --path package-lock.json --validate-https --allowed-hosts npm yarn",
+    "test": "c8 node --loader ts-node/esm --test __tests__/**",
+    "test:watch": "c8 node --loader ts-node/esm --test --watch __tests__/**",
+    "coverage:view": "open coverage/lcov-report/index.html",
+    "version": "changeset version",
+    "release": "changeset publish"
   },
   "author": {
     "name": "<%= author %>",
     "email": "<%= email %>",
     "url": "https://github.com/<%= username %>"
   },
+  "publishConfig": {
+    "provenance": true,
+    "access": "public"
+  },
   "license": "Apache-2.0",
   "keywords": [
     "<%= keywords %>"
@@ -44,179 +64,25 @@
     "type": "git",
     "url": "<%= projectRepository %>.git"
   },
-  "dependencies": {},
   "devDependencies": {
-    "@babel/core": "^7.20.12",
-    "@babel/eslint-parser": "^7.19.1",
-    "@babel/plugin-syntax-top-level-await": "^7.14.5",
-    "@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",
-    "eslint": "^8.33.0",
-    "eslint-plugin-jest": "^27.2.1",
-    "eslint-plugin-node": "^11.1.0",
-    "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",
-    "verbose": true,
-    "collectCoverage": true,
-    "coverageThreshold": {
-      "global": {
-        "branches": 80,
-        "functions": 80,
-        "lines": 80,
-        "statements": 80
-      }
-    },
-    "testPathIgnorePatterns": [
-      "/__tests__/.*/__fixtures__/.*"
-    ],
-    "collectCoverageFrom": [
-      "index.js",
-      "src/**/*.{js,ts}"
-    ],
-    "testMatch": [
-      "**/*.test.js"
-    ]
+    "@changesets/changelog-github": "^0.5.0",
+    "@changesets/cli": "^2.27.7",
+    "@types/node": "^20.14.10",
+    "c8": "^10.1.2",
+    "eslint": "^9.6.0",
+    "eslint-plugin-security": "^3.0.1",
+    "husky": "^9.0.11",
+    "lint-staged": "^15.2.7",
+    "lockfile-lint": "^4.14.0",
+    "neostandard": "^0.11.0",
+    "ts-node": "^10.9.2",
+    "tsup": "^8.1.0",
+    "typescript": "^5.5.3",
+    "validate-conventional-commit": "^1.0.4"
   },
   "lint-staged": {
     "**/*.{js,json}": [
-      "<%= npmClient %> run format"
-    ]
-  },
-  "husky": {
-    "hooks": {
-      "commit-msg": "commitlint --env HUSKY_GIT_PARAMS",
-      "pre-commit": "lint-staged",
-      "pre-push": "<%= npmClient %> run lint && <%= npmClient %> run test",
-      "post-commit": "git status",
-      "post-checkout": "git status",
-      "post-merge": "<%= npmClient %> install"
-    }
-  },
-  "commitlint": {
-    "extends": [
-      "@commitlint/config-conventional"
-    ]
-  },
-  "standard": {
-    "env": [
-      "jest"
-    ],
-    "parser": "babel-eslint",
-    "ignore": [
-      "**/out/"
-    ]
-  },
-  "eslintIgnore": [
-    "coverage/**"
-  ],
-  "babel": {
-    "plugins": [
-      "@babel/plugin-syntax-top-level-await"
+      "npm run lint:fix"
     ]
-  },
-  "eslintConfig": {
-    "plugins": [
-      "node",
-      "security",
-      "jest"
-    ],
-    "extends": [
-      "plugin:node/recommended"
-    ],
-    "rules": {
-      "node/no-unsupported-features/es-syntax": [
-        "error",
-        {
-          "ignores": [
-            "dynamicImport",
-            "modules"
-          ]
-        }
-      ],
-      "no-process-exit": "warn",
-      "jest/no-disabled-tests": "error",
-      "jest/no-focused-tests": "error",
-      "jest/no-identical-title": "error",
-      "node/no-unsupported-features": "off",
-      "node/no-unpublished-require": "off",
-      "security/detect-non-literal-fs-filename": "error",
-      "security/detect-unsafe-regex": "error",
-      "security/detect-buffer-noassert": "error",
-      "security/detect-child-process": "error",
-      "security/detect-disable-mustache-escape": "error",
-      "security/detect-eval-with-expression": "error",
-      "security/detect-no-csrf-before-method-override": "error",
-      "security/detect-non-literal-regexp": "error",
-      "security/detect-object-injection": "warn",
-      "security/detect-possible-timing-attacks": "error",
-      "security/detect-pseudoRandomBytes": "error",
-      "space-before-function-paren": "off",
-      "object-curly-spacing": "off"
-    },
-    "parser": "@babel/eslint-parser",
-    "parserOptions": {
-      "sourceType": "module",
-      "ecmaFeatures": {
-        "impliedStrict": true
-      }
-    }
-  },
-  "release": {
-    "branches": [
-      "main",
-      "master"
-    ],
-    "analyzeCommits": {
-      "preset": "angular",
-      "releaseRules": [
-        {
-          "type": "docs",
-          "release": "patch"
-        },
-        {
-          "type": "refactor",
-          "release": "patch"
-        },
-        {
-          "type": "style",
-          "release": "patch"
-        }
-      ]
-    }
-  },
-  "plugins": [
-    "@semantic-release/commit-analyzer",
-    "@semantic-release/release-notes-generator",
-    [
-      "@semantic-release/changelog",
-      {
-        "changelogFile": "CHANGELOG.md"
-      }
-    ],
-    "@semantic-release/npm",
-    [
-      "@semantic-release/git",
-      {
-        "assets": [
-          "CHANGELOG.md"
-        ]
-      }
-    ],
-    "@semantic-release/github"
-  ]
+  }
 }

package/template/src/bin/cli.ts

@@ -0,0 +1,12 @@
+#!/usr/bin/env node
+import { debuglog } from 'node:util'
+import { add } from '../main.ts'
+
+const debug = debuglog('<%= projectName %>')
+
+async function init () {
+    const sum = await add(1,2)
+    debug(sum.toString())
+}
+
+init()

package/template/src/main.ts

@@ -0,0 +1,3 @@
+export async function add(arg1: number, arg2: number): Promise<number> {
+  return Promise.resolve(arg1 + arg2)
+}

package/template/tsconfig.json

@@ -0,0 +1,37 @@
+{
+  "compilerOptions": {
+    "lib": [
+      "ES2022"
+    ],
+    "strict": true,
+    "allowJs": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "moduleResolution": "NodeNext",
+    "module": "NodeNext",
+    "target": "ES2022",
+    "baseUrl": ".",
+    "noEmit": true,
+    "rootDir": "./src",
+    "declaration": true,
+    "declarationMap": true,
+    "sourceMap": true,
+		"allowImportingTsExtensions": true,
+    "allowSyntheticDefaultImports": true,
+		"forceConsistentCasingInFileNames": true,
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "removeComments": true,
+  },
+  "include": [
+    "src/**/*",
+    "src/bin/**/*"
+  ],
+  "exclude": [
+    "dist",
+    "node_modules"
+  ],
+  "ts-node": {
+    "transpileOnly": true,
+  }
+}

package/template/tsup.config.ts

@@ -0,0 +1,29 @@
+import { defineConfig } from 'tsup'
+
+export default defineConfig([
+  {
+    entryPoints: ['src/main.ts', 'src/bin/cli.ts'],
+    format: ['cjs', 'esm'],
+    dts: true,
+    minify: false,
+    outDir: 'dist/',
+    clean: true,
+    sourcemap: false,
+    bundle: true,
+    splitting: false,
+    outExtension (ctx) {
+      return {
+        dts: '.d.ts',
+        js: ctx.format === 'cjs' ? '.cjs' : '.mjs',
+      }
+    },
+    treeshake: false,
+    target: 'es2022',
+    platform: 'node',
+    tsconfig: './tsconfig.json',
+    cjsInterop: true,
+    keepNames: true,
+    skipNodeModulesBundle: false,
+  },
+
+])

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

@@ -1,44 +0,0 @@
----
-name: "\U0001F41B Bug report"
-about: Create a bug report
----
-
-<!--- Provide a general summary of the issue in the Title above -->
-
-## Expected Behavior
-
-<!--- If you're describing a bug, tell us what should happen -->
-<!--- If you're suggesting a change/improvement, tell us how it should work -->
-
-## Current Behavior
-
-<!--- If describing a bug, tell us what happens instead of the expected behavior -->
-<!--- If suggesting a change/improvement, explain the difference from current behavior -->
-
-## Possible Solution
-
-<!--- Not obligatory, but suggest a fix/reason for the bug, -->
-<!--- or ideas how to implement the addition or change -->
-
-## Steps to Reproduce (for bugs)
-
-<!--- Provide a link to a live example, or an unambiguous set of steps to -->
-<!--- reproduce this bug. Include code to reproduce, if relevant -->
-
-1.
-2.
-3.
-4.
-
-## Context
-
-<!--- How has this issue affected you? What are you trying to accomplish? -->
-<!--- Providing context helps us come up with a solution that is most useful in the real world -->
-
-## Your Environment
-
-<!--- Include as many relevant details about the environment you experienced the bug in -->
-
-- Library Version used:
-- Node.js version (e.g. Node.js 5.4):
-- Operating System and version (desktop or mobile):

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

@@ -1,19 +0,0 @@
----
-name: "\U0001F680 Feature request"
-about: Suggest an idea for this project
----
-
-<!--
-Thank you for suggesting an idea to make this project better!
-
-Please fill in as much of the template below as you're able.
--->
-
-**Is your feature request related to a problem? Please describe.**
-Please describe the problem you are trying to solve.
-
-**Describe the solution you'd like**
-Please describe the desired behavior.
-
-**Describe alternatives you've considered**
-Please describe alternative solutions or features you have considered.

package/template/.github/workflows/main.yml

@@ -1,53 +0,0 @@
-<% const npmClientInstall = context.npmClient === 'yarn' ? 'yarn install --frozen-lockfile' : 'npm ci' -%>
-name: CI
-
-on: [push, pull_request]
-
-jobs:
-  lint:
-    name: Lint
-    runs-on: 'ubuntu-latest'
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
-        with:
-          node-version: '18'
-      - name: install dependencies
-        run: <%= npmClientInstall %>
-      - name: lint code
-        run: <%= npmClient %> run lint
-
-  build:
-    strategy:
-      matrix:
-        platform: [ubuntu-latest]
-        node: ['14', '16', '18']
-    name: Tests - Node ${{ matrix.node }} (${{ matrix.platform }})
-    runs-on: ${{ matrix.platform }}
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
-        with:
-          node-version: ${{ matrix.node }}
-      - name: install dependencies
-        run: <%= npmClientInstall %> --ignore-engines
-      - name: run tests
-        run: npm run test
-
-  release:
-    name: do semantic release
-    runs-on: 'ubuntu-latest'
-    needs: build
-    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
-        with:
-          node-version: '18'
-      - name: install dependencies
-        run: <%= npmClientInstall %> --ignore-engines --only=production
-      - name: release
-        run: npx semantic-release
-        env:
-          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
-          NPM_TOKEN: ${{secrets.NPM_TOKEN}}

package/template/__tests__/app.test.js

@@ -1,5 +0,0 @@
-import { add } from '../src/main.js'
-
-test('1 + 1 is 2', () => {
-  expect(add(1, 1)).toBe(2)
-})

package/template/bin/cli.js

@@ -1,4 +0,0 @@
-#!/usr/bin/env node
-import { add } from '../src/main.js'
-
-console.log(add(1, 2))

package/template/gitignore

@@ -1,111 +0,0 @@
-# Logs
-
-logs
-_.log
-npm-debug.log_
-yarn-debug.log*
-yarn-error.log*
-
-# Runtime data
-
-pids
-_.pid
-_.seed
-\*.pid.lock
-
-# Directory for instrumented libs generated by jscoverage/JSCover
-
-lib-cov
-
-# Coverage directory used by tools like istanbul
-
-coverage
-
-# nyc test coverage
-
-.nyc_output
-
-# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
-
-.grunt
-
-# Bower dependency directory (https://bower.io/)
-
-bower_components
-
-# node-waf configuration
-
-.lock-wscript
-
-# Compiled binary addons (https://nodejs.org/api/addons.html)
-
-build/Release
-
-# Dependency directories
-
-node_modules/
-jspm_packages/
-
-# TypeScript v1 declaration files
-
-typings/
-
-# Optional npm cache directory
-
-.npm
-
-# Optional eslint cache
-
-.eslintcache
-
-# Optional REPL history
-
-.node_repl_history
-
-# Output of 'npm pack'
-
-\*.tgz
-
-# Yarn Integrity file
-
-.yarn-integrity
-
-# dotenv environment variables file
-
-.env
-.env.test
-
-# parcel-bundler cache (https://parceljs.org/)
-
-.cache
-
-# next.js build output
-
-.next
-
-# nuxt.js build output
-
-.nuxt
-
-# vuepress build output
-
-.vuepress/dist
-
-# Serverless directories
-
-.serverless/
-
-# FuseBox cache
-
-.fusebox/
-
-# DynamoDB Local files
-
-.dynamodb/
-
-# Snyk Code
-
-.dccache
-
-# Visual Studio Code
-.vscode/

package/template/src/main.js

@@ -1,5 +0,0 @@
-function add(x, y) {
-  return x + y
-}
-
-export { add }