@cucumber/create-meta - npm Package Compare versions

Comparing version 6.0.2 to 6.0.3

dist/src/ciDict.js

 "use strict";
+// This file is auto-generated using npm run build-ci-dict
 Object.defineProperty(exports, "__esModule", { value: true });
@@ -3,0 +4,0 @@ exports.ciDict = void 0;

dist/src/createMeta.js

@@ -26,10 +26,10 @@ "use strict";
 exports.removeUserInfoFromUrl = exports.detectCI = void 0;
+const messages = __importStar(require("@cucumber/messages"));
 const os_1 = __importDefault(require("os"));
 const url_1 = require("url");
-const messages = __importStar(require("@cucumber/messages"));
-const ciDict_json_1 = __importDefault(require("./ciDict.json"));
+const ciDict_1 = require("./ciDict");
 const evaluateVariableExpression_1 = __importDefault(require("./evaluateVariableExpression"));
 function createMeta(toolName, toolVersion, envDict, ciDict) {
     if (ciDict === undefined) {
-        ciDict = ciDict_json_1.default;
+        ciDict = ciDict_1.ciDict;
     }
@@ -94,2 +94,11 @@ return {
     const branch = (0, evaluateVariableExpression_1.default)(ciSystem.git.branch, envDict);
+    const tag = (0, evaluateVariableExpression_1.default)(ciSystem.git.tag, envDict);
+    const git = {
+        remote: removeUserInfoFromUrl((0, evaluateVariableExpression_1.default)(ciSystem.git.remote, envDict)),
+        revision: (0, evaluateVariableExpression_1.default)(ciSystem.git.revision, envDict),
+        branch: branch,
+    };
+    if (tag) {
+        git['tag'] = tag;
+    }
     return {
@@ -99,10 +108,5 @@ name: ciName,
         buildNumber,
-        git: {
-            remote: removeUserInfoFromUrl((0, evaluateVariableExpression_1.default)(ciSystem.git.remote, envDict)),
-            revision: (0, evaluateVariableExpression_1.default)(ciSystem.git.revision, envDict),
-            branch: branch,
-            tag: (0, evaluateVariableExpression_1.default)(ciSystem.git.tag, envDict),
-        },
+        git: git,
     };
 }
 //# sourceMappingURL=createMeta.js.map

dist/src/printMeta.js

@@ -11,10 +11,7 @@ "use strict";
 };
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.main = void 0;
 const fs_1 = require("fs");
+const ciDict_1 = require("./ciDict");
 const createMeta_1 = require("./createMeta");
-const ciDict_json_1 = __importDefault(require("./ciDict.json"));
 function main(envPath, stdout) {
@@ -25,3 +22,3 @@ return __awaiter(this, void 0, void 0, function* () {
         const env = Object.fromEntries(entries);
-        const ci = (0, createMeta_1.detectCI)(ciDict_json_1.default, env);
+        const ci = (0, createMeta_1.detectCI)(ciDict_1.ciDict, env);
         stdout.write(JSON.stringify(ci, null, 2) + '\n');
@@ -28,0 +25,0 @@ });

dist/test/createMetaTest.js

@@ -6,5 +6,4 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+const assert_1 = __importDefault(require("assert"));
 const createMeta_1 = __importDefault(require("../src/createMeta"));
-const assert_1 = __importDefault(require("assert"));
-const ciDict_json_1 = __importDefault(require("../src/ciDict.json"));
 describe('createMeta', () => {
@@ -25,3 +24,3 @@ it('defines the implementation product', () => {
         };
-        const meta = (0, createMeta_1.default)('someTool', '1.2.3', envDict, ciDict_json_1.default);
+        const meta = (0, createMeta_1.default)('someTool', '1.2.3', envDict);
         const ci = {
@@ -48,3 +47,3 @@ name: 'CircleCI',
         };
-        const meta = (0, createMeta_1.default)('someTool', '1.2.3', envDict, ciDict_json_1.default);
+        const meta = (0, createMeta_1.default)('someTool', '1.2.3', envDict);
         const ci = {
@@ -71,3 +70,3 @@ name: 'GitHub Actions',
         };
-        const meta = (0, createMeta_1.default)('someTool', '1.2.3', envDict, ciDict_json_1.default);
+        const meta = (0, createMeta_1.default)('someTool', '1.2.3', envDict);
         const ci = {
@@ -81,3 +80,2 @@ name: 'GitHub Actions',
                 revision: 'the-revision',
-                tag: undefined,
             },
@@ -95,3 +93,3 @@ };
         };
-        const meta = (0, createMeta_1.default)('someTool', '1.2.3', envDict, ciDict_json_1.default);
+        const meta = (0, createMeta_1.default)('someTool', '1.2.3', envDict);
         const ci = {
@@ -105,3 +103,2 @@ name: 'Azure Pipelines',
                 revision: 'the-revision',
-                tag: undefined,
             },
@@ -119,3 +116,3 @@ };
         };
-        const meta = (0, createMeta_1.default)('someTool', '1.2.3', envDict, ciDict_json_1.default);
+        const meta = (0, createMeta_1.default)('someTool', '1.2.3', envDict);
         const ci = {
@@ -143,7 +140,6 @@ name: 'Azure Pipelines',
         };
-        const meta = (0, createMeta_1.default)('someTool', '1.2.3', envDict, ciDict_json_1.default);
+        const meta = (0, createMeta_1.default)('someTool', '1.2.3', envDict);
         const ci = {
             git: {
                 branch: 'main',
-                tag: undefined,
                 remote: 'https://github.com/cucumber-ltd/shouty.rb.git',
@@ -150,0 +146,0 @@ revision: '057f8fe233b17629af084064c2a7b8d1dbb795ad',

dist/test/removeUserInfoFromUrlTest.js

@@ -6,4 +6,4 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+const assert_1 = __importDefault(require("assert"));
 const createMeta_1 = require("../src/createMeta");
-const assert_1 = __importDefault(require("assert"));
 describe('removeUserInfoFromUrl', () => {
@@ -10,0 +10,0 @@ it('returns undefined for undefined', () => {

package.json

 {
   "name": "@cucumber/create-meta",
-  "version": "6.0.2",
+  "version": "6.0.3",
   "description": "Produce the meta message for Cucumber JavaScript",
@@ -8,5 +8,9 @@ "main": "dist/src/index.js",
   "scripts": {
+    "pretest": "npm run build-ci-dict",
     "test": "mocha",
     "prepublishOnly": "tsc --build tsconfig.build.json",
-    "print-meta": "ts-node --require source-map-support/register --require tsconfig-paths/register ./src/printMeta.ts"
+    "print-meta": "ts-node --require source-map-support/register --require tsconfig-paths/register ./src/printMeta.ts",
+    "eslint-fix": "eslint --ext ts,tsx --max-warnings 0 --fix src test",
+    "eslint": "eslint --ext ts,tsx --max-warnings 0 src test",
+    "build-ci-dict": "cat ciDict.ts.header > src/ciDict.ts && cat ../ciDict.json >> src/ciDict.ts && eslint --fix src/ciDict.ts"
   },
@@ -27,8 +31,18 @@ "repository": {
   "devDependencies": {
-    "@types/glob": "7.1.4",
+    "@types/glob": "7.2.0",
     "@types/mocha": "9.0.0",
-    "@types/node": "14.17.27",
+    "@types/node": "16.11.7",
+    "@typescript-eslint/eslint-plugin": "5.3.1",
+    "@typescript-eslint/parser": "5.3.1",
+    "eslint": "8.2.0",
+    "eslint-config-prettier": "8.3.0",
+    "eslint-plugin-import": "2.25.3",
+    "eslint-plugin-node": "11.1.0",
+    "eslint-plugin-prettier": "4.0.0",
+    "eslint-plugin-simple-import-sort": "7.0.0",
     "mocha": "9.1.3",
+    "prettier": "2.4.1",
     "source-map-support": "0.5.20",
-    "ts-node": "10.3.0",
+    "ts-node": "10.4.0",
+    "tsconfig-paths": "3.11.0",
     "typescript": "4.4.4"
@@ -35,0 +49,0 @@ },

src/ciDict.ts

@@ -0,1 +1,3 @@
+// This file is auto-generated using npm run build-ci-dict
+
 import { CiDict } from './types'
@@ -2,0 +4,0 @@

src/createMeta.ts

@@ -0,8 +1,16 @@
+import * as messages from '@cucumber/messages'
 import os from 'os'
-import { parse as parseUrl, format as formatUrl } from 'url'
-import * as messages from '@cucumber/messages'
-import defaultCiDict from './ciDict.json'
+import { format as formatUrl, parse as parseUrl } from 'url'
+
+import { ciDict as defaultCiDict } from './ciDict'
 import evaluateVariableExpression from './evaluateVariableExpression'
 import { CiDict, CiSystem, Env } from './types'
 
+type GitInfo = {
+  remote: string
+  revision: string
+  branch: string
+  tag?: string
+}
+
 export default function createMeta(
@@ -80,2 +88,13 @@ toolName: string,
   const branch = evaluateVariableExpression(ciSystem.git.branch, envDict)
+  const tag = evaluateVariableExpression(ciSystem.git.tag, envDict)
+  const git: GitInfo = {
+    remote: removeUserInfoFromUrl(evaluateVariableExpression(ciSystem.git.remote, envDict)),
+    revision: evaluateVariableExpression(ciSystem.git.revision, envDict),
+    branch: branch,
+  }
+
+  if (tag) {
+    git['tag'] = tag
+  }
+
   return {
@@ -85,9 +104,4 @@ name: ciName,
     buildNumber,
-    git: {
-      remote: removeUserInfoFromUrl(evaluateVariableExpression(ciSystem.git.remote, envDict)),
-      revision: evaluateVariableExpression(ciSystem.git.revision, envDict),
-      branch: branch,
-      tag: evaluateVariableExpression(ciSystem.git.tag, envDict),
-    },
+    git: git,
   }
 }

src/printMeta.ts

 import { promises as fs } from 'fs'
-import { detectCI } from './createMeta'
-import ciDict from './ciDict.json'
 import { Writable } from 'stream'
 
+import { ciDict } from './ciDict'
+import { detectCI } from './createMeta'
+
 export async function main(envPath: string, stdout: Writable) {
@@ -7,0 +8,0 @@ const envData = await fs.readFile(envPath, 'utf-8')

test/createMetaTest.ts

@@ -1,6 +0,6 @@
-import createMeta from '../src/createMeta'
+import * as messages from '@cucumber/messages'
 import assert from 'assert'
-import ciDict from '../src/ciDict.json'
-import * as messages from '@cucumber/messages'
 
+import createMeta from '../src/createMeta'
+
 describe('createMeta', () => {
@@ -24,3 +24,3 @@ it('defines the implementation product', () => {
 
-    const meta = createMeta('someTool', '1.2.3', envDict, ciDict)
+    const meta = createMeta('someTool', '1.2.3', envDict)
     const ci: messages.Ci = {
@@ -49,3 +49,3 @@ name: 'CircleCI',
 
-    const meta = createMeta('someTool', '1.2.3', envDict, ciDict)
+    const meta = createMeta('someTool', '1.2.3', envDict)
     const ci: messages.Ci = {
@@ -74,3 +74,3 @@ name: 'GitHub Actions',
 
-    const meta = createMeta('someTool', '1.2.3', envDict, ciDict)
+    const meta = createMeta('someTool', '1.2.3', envDict)
     const ci: messages.Ci = {
@@ -84,3 +84,2 @@ name: 'GitHub Actions',
         revision: 'the-revision',
-        tag: undefined,
       },
@@ -100,3 +99,3 @@ }
 
-    const meta = createMeta('someTool', '1.2.3', envDict, ciDict)
+    const meta = createMeta('someTool', '1.2.3', envDict)
     const ci: messages.Ci = {
@@ -110,3 +109,2 @@ name: 'Azure Pipelines',
         revision: 'the-revision',
-        tag: undefined,
       },
@@ -126,3 +124,3 @@ }
 
-    const meta = createMeta('someTool', '1.2.3', envDict, ciDict)
+    const meta = createMeta('someTool', '1.2.3', envDict)
     const ci: messages.Ci = {
@@ -152,7 +150,6 @@ name: 'Azure Pipelines',
 
-    const meta = createMeta('someTool', '1.2.3', envDict, ciDict)
+    const meta = createMeta('someTool', '1.2.3', envDict)
     const ci: messages.Ci = {
       git: {
         branch: 'main',
-        tag: undefined,
         remote: 'https://github.com/cucumber-ltd/shouty.rb.git',
@@ -159,0 +156,0 @@ revision: '057f8fe233b17629af084064c2a7b8d1dbb795ad',

test/evaluateVariableExpressionTest.ts

 import assert from 'assert'
+
 import evaluateVariableExpression from '../src/evaluateVariableExpression'
@@ -3,0 +4,0 @@

test/removeUserInfoFromUrlTest.ts

@@ -1,4 +0,5 @@
-import { removeUserInfoFromUrl } from '../src/createMeta'
 import assert from 'assert'
 
+import { removeUserInfoFromUrl } from '../src/createMeta'
+
 describe('removeUserInfoFromUrl', () => {
@@ -5,0 +6,0 @@ it('returns undefined for undefined', () => {

tsconfig.build.json

 {
-  "extends": "../../tsconfig.build.json",
+  "extends": "./tsconfig.base.json",
   "compilerOptions": {
+    "composite": true,
+    "declaration": true,
+    "declarationMap": true,
+    "sourceMap": true,
+    "target": "es6",
+    "module": "commonjs",
     "rootDir": ".",
@@ -8,3 +14,2 @@ "outDir": "dist"
   "include": [
-    "src/ciDict.json",
     "src",
@@ -11,0 +16,0 @@ "test"

tsconfig.json

 {
-  "extends": "../../tsconfig.json"
+  "extends": "./tsconfig.base.json",
+  "compilerOptions": {
+    "baseUrl": ".",
+    "paths": {
+      "@cucumber/messages": ["messages/javascript"],
+      "@cucumber/message-streams": ["message-streams/javascript"],
+      "@cucumber/gherkin": ["gherkin/javascript/src/index.ts"],
+      "@cucumber/gherkin-streams": ["gherkin-streams/javascript/src/index.ts"],
+      "@cucumber/gherkin-utils": ["gherkin-utils/javascript/src/index.ts"],
+      "@cucumber/create-meta": ["create-meta/javascript/src/index.ts"],
+      "@cucumber/fake-cucumber": ["fake-cucumber/javascript/src/index.ts"],
+      "@cucumber/query": ["query/javascript/src/index.ts"],
+      "@cucumber/compatibility-kit": ["compatibility-kit/javascript/src/index.ts"],
+      "@cucumber/react": ["react/javascript/src/index.ts"]
+    },
+    "noEmit": true
+  }
 }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Number of package files

63

increased by5%

Worsened metrics

Total package byte prevSize

84500

decreased by-16.36%

Dev dependency count

17

increased by142.86%

Lines of code

1276

decreased by-9.31%

Number of low supply chain risk alerts

2

increased by100%

No dependency changes