feat: Break apart modules and updates dependencies

BREAKING CHANGE: Shift to modules

Author: dawsontoth

.github/dependabot.yml

@@ -0,0 +1,55 @@
+name: Release
+
+on:
+  merge_group:
+    branches:
+      - main
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+# Needed for semantic-release to create GitHub releases and publish to npm via OIDC
+permissions:
+  contents: write
+  issues: write
+  pull-requests: write
+  id-token: write
+
+concurrency:
+  group: Release
+  cancel-in-progress: false
+
+jobs:
+  release:
+    name: Semantic Release
+    environment: Release
+    # Ensure releases run only when code reaches main via GitHub Merge Queue, or when manually dispatched
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0
+        with:
+          fetch-depth: 0
+      - name: Setup Node.js
+        uses: actions/setup-node@2028fbc5c25fe9cf00d9f06a71cc4710d4507903 # v6.0.0
+        with:
+          node-version-file: '.nvmrc'
+          cache: npm
+          registry-url: 'https://registry.npmjs.org'
+      - name: Update npm
+        run: npm install -g npm@latest
+      - name: Install dependencies
+        run: npm ci
+      - name: Run ESLint
+        run: npm run lint
+      - name: Run unit tests
+        run: npm run test:ci
+      - name: Semantic Release
+        if: ${{ github.event_name == 'push' }}
+        uses: cycjimmy/semantic-release-action@b12c8f6015dc215fe37bc154d4ad456dd3833c90 # v6.0.0
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_CONFIG_PROVENANCE: true
+      - name: Publish to NPM
+        run: npm publish --provenance

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,37 @@
+name: Verify PR
+
+on:
+  pull_request:
+
+jobs:
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0
+      - name: Setup Node.js
+        uses: actions/setup-node@2028fbc5c25fe9cf00d9f06a71cc4710d4507903 # v6.0.0
+        with:
+          node-version-file: '.nvmrc'
+          cache: npm
+      - name: Install dependencies
+        run: npm ci
+      - name: Run ESLint
+        run: npm run lint
+
+  test:
+    name: Test
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0
+      - name: Setup Node.js
+        uses: actions/setup-node@2028fbc5c25fe9cf00d9f06a71cc4710d4507903 # v6.0.0
+        with:
+          node-version-file: '.nvmrc'
+          cache: npm
+      - name: Install dependencies
+        run: npm ci
+      - name: Run unit tests
+        run: npm run test:ci

.github/workflows/release.yml

@@ -0,0 +1,4 @@
+*
+!index.js
+!lib/**/*.js
+lib/**/*.test.js

.github/workflows/verify-pr.yml

@@ -0,0 +1 @@
+24.11.1

.npmignore

@@ -0,0 +1,50 @@
+{
+  "branches": [
+    "main"
+  ],
+  "plugins": [
+    [
+      "@semantic-release/commit-analyzer",
+      {
+        "preset": "conventionalcommits",
+        "releaseRules": [
+          {
+            "breaking": true,
+            "release": "major"
+          },
+          {
+            "type": "feat",
+            "release": "minor"
+          },
+          {
+            "type": "*",
+            "release": "patch"
+          }
+        ],
+        "parserOpts": {
+          "noteKeywords": [
+            "BREAKING CHANGE",
+            "BREAKING CHANGES"
+          ]
+        }
+      }
+    ],
+    "@semantic-release/release-notes-generator",
+    [
+      "@semantic-release/npm",
+      {
+        "npmPublish": false
+      }
+    ],
+    [
+      "@semantic-release/git",
+      {
+        "assets": [
+          "package.json",
+          "package-lock.json"
+        ]
+      }
+    ],
+    "@semantic-release/github"
+  ]
+}

.nvmrc

@@ -6,7 +6,7 @@ My old Gaffer is tired of writing code, so he generates it instead! This is how
 
 ## Requirements
 
-Install the latest LTS of NodeJS. Or a version around v8.11.3. Or try whatever you've got installed already, maybe it will work!
+Install the latest LTS of NodeJS. Or a version around v24. Or try whatever you've got installed already, maybe it will work!
 https://nodejs.org/en/
 
 Also install `yarn`. Or don't, and use `npm` instead.
@@ -91,5 +91,5 @@ There are several flags you can pass. To see them, run `gaffer-generator --help`
 ## Testing
 
 ```$bash
-yarn test
+npm run test
 ```

.releaserc.json

@@ -1,38 +1,44 @@
 #!/usr/bin/env node
-require('yargs')
-  .command({
-    command: 'generate [directory]',
-    aliases: ['gen', 'g'],
-    desc: 'Recursively looks for .templateroots in the current directory, or supplied directory',
-    builder: yargs => yargs.default('directory', './'),
-    handler: argv => require('./src/generate/root').run(argv.directory),
-  })
-  .command({
-    command: 'create [directory] [--overwrite]',
-    aliases: ['c'],
-    desc: 'Create a starting .templateroot in to the current directory, or supplied directory',
-    builder: yargs => yargs.default('directory', './example.templateroot'),
-    handler: argv => require('./src/create').run(argv.directory),
-  })
-  .options({
-    'dry-run': {
-      boolean: true,
-      describe: 'Logs the changes that would be made without actually touching the file system.',
-    },
-    'into': {
-      string: true,
-      describe: 'Overrides the directory that .templateroots will target. Useful for targeting dynamic directories.',
-    },
-    'silent': {
-      boolean: true,
-      describe: 'Disables console logging.',
-    },
-    'no-colors': {
-      boolean: true,
-      describe: 'Turns off console coloring of text.',
-    },
-  })
-  .demandCommand()
-  .help()
-  .wrap(72)
-  .argv;
+import yargs from 'yargs';
+import { hideBin } from 'yargs/helpers';
+import { setArgv } from './lib/argv.js';
+
+setArgv(
+  yargs(hideBin(process.argv))
+    .command({
+      command: 'generate [directory]',
+      aliases: ['gen', 'g'],
+      desc: 'Recursively looks for .templateroots in the current directory, or supplied directory',
+      builder: yargs => yargs.default('directory', './'),
+      handler: async argv => (await import('./lib/generate/root.js')).run(argv.directory),
+    })
+    .command({
+      command: 'create [directory] [--overwrite]',
+      aliases: ['c'],
+      desc: 'Create a starting .templateroot in to the current directory, or supplied directory',
+      builder: yargs => yargs.default('directory', './example.templateroot'),
+      handler: async argv => (await import('./lib/create.js')).run(argv.directory),
+    })
+    .options({
+      'dry-run': {
+        boolean: true,
+        describe: 'Logs the changes that would be made without actually touching the file system.',
+      },
+      'into': {
+        string: true,
+        describe: 'Overrides the directory that .templateroots will target. Useful for targeting dynamic directories.',
+      },
+      'silent': {
+        boolean: true,
+        describe: 'Disables console logging.',
+      },
+      'no-colors': {
+        boolean: true,
+        describe: 'Turns off console coloring of text.',
+      },
+    })
+    .demandCommand()
+    .help()
+    .wrap(72)
+    .argv,
+);