gaffer-generator 1.2.4 → 1.2.7

package/.github/dependabot.yml

@@ -0,0 +1,8 @@
+version: 2
+updates:
+- package-ecosystem: npm
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "10:00"
+  open-pull-requests-limit: 10

package/.github/workflows/codeql-analysis.yml

@@ -0,0 +1,67 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ master ]
+  schedule:
+    - cron: '22 16 * * 6'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'javascript' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
+        # Learn more:
+        # https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v3
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v3
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v3

package/README.md

@@ -62,11 +62,11 @@ You should see output similar to the following:
 Let's break down the discrete steps that happened above:
 
 1. We search the current directory recursively for `.templateroot` directories.
-2. When one is found, we read in the `template.js` file (it should be a CommonJS module).
+2. When one is found, we read in the `template.cjs` (or `template.js`) file (it should be a CommonJS module).
 3. Call the `download` method of this file, which should return a promise that eventually resolves to any JSON describing what you want to generate.
-4. Using the exported `into` property from the `template.js`, we'll recursively look at all of the other files within the `.templateroot`.
+4. Using the exported `into` property from the `template.cjs` (or `template.js`), we'll recursively look at all of the other files within the `.templateroot`.
 5. When we find a directory, recurse in to it!
-6. When we find a file, parse it as a [lodash template](https://lodash.com/docs/4.17.11#template). The context will be whatever was returned from the `download` promise above, plus any exported methods of our `template.js` will be exposed on the `utils` object.
+6. When we find a file, parse it as a [lodash template](https://lodash.com/docs/4.17.11#template). The context will be whatever was returned from the `download` promise above, plus any exported methods of our `template.cjs` (or `template.js`) will be exposed on the `utils` object.
 7. When we find a variable in the path, like `_fileName_.ts`, evaluate it based on our context from `download`.
 8. When we find a `_each` in the path, like `_eachEnum.fileName_.ts`, expand it out. This lets us generate many files from a single template.
 

package/SECURITY.md

@@ -0,0 +1,15 @@
+# Security Policy
+
+## Supported Versions
+
+Use this section to tell people about which versions of your project are
+currently being supported with security updates.
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 1.x     | :white_check_mark: |
+
+## Reporting a Vulnerability
+
+If you discover a vulnerability, please create an Issue, or better yet,
+a Pull Request, and we'll tackle it together!

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gaffer-generator",
-  "version": "1.2.4",
+  "version": "1.2.7",
   "description": "",
   "main": "cli.js",
   "scripts": {
@@ -14,13 +14,13 @@
   "license": "MIT",
   "dependencies": {
     "colors": "^1.4.0",
-    "globule": "^1.3.2",
-    "node-fetch": "^2.6.1",
-    "recursive-copy": "^2.0.11",
-    "yargs": "^16.2.0"
+    "globule": "^1.3.4",
+    "node-fetch": "^2.6.7",
+    "recursive-copy": "^2.0.14",
+    "yargs": "^17.6.2"
   },
   "devDependencies": {
-    "jest": "^26.6.3",
-    "ts-node": "^9.1.1"
+    "jest": "^29.3.1",
+    "ts-node": "^10.9.1"
   }
 }

package/renovate.json

@@ -0,0 +1,6 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": [
+    "config:base"
+  ]
+}

package/src/generate/directory.js

@@ -10,7 +10,7 @@ const utils = require('../utils');
 const dryRun = argv.dryRun || false;
 const node = require('./node');
 
-const reservedItems = ['template.js', 'template.ts', 'template'];
+const reservedItems = ['template.cjs', 'template.js', 'template.ts', 'template', '.DS_Store'];
 
 /*
  Public API.

package/src/generate/root.js

@@ -31,7 +31,7 @@ function visit(rootPath) {
   const templateSettingsPath = determineTemplateFile(rootPath);
   if (!templateSettingsPath) {
     utils.logError(
-      'Found .templateroot without a template.js or template.ts file:\n'.red
+      'Found .templateroot without a template.cjs, template.js or template.ts file:\n'.red
       + rootPath.cyan);
     return;
   }
@@ -64,8 +64,12 @@ function visit(rootPath) {
 }
 
 function determineTemplateFile(rootPath) {
+  const cjsTemplate = path.join(rootPath, 'template.cjs');
   const jsTemplate = path.join(rootPath, 'template.js');
   const tsTemplate = path.join(rootPath, 'template.ts');
+  if (fs.existsSync(cjsTemplate)) {
+    return cjsTemplate;
+  }
   if (fs.existsSync(jsTemplate)) {
     return jsTemplate;
   }