IN-4062 Consolidate engineering-toolkit

.changeset/eleven-boxes-glow.md

@@ -0,0 +1,5 @@
+---
+"@vue-storefront/eslint-config": patch
+---
+
+[REMOVED] Plugin "eslint-plugin-no-unsanitized" was removed due to a license that was noncompliant with our Open Source Guidelines

.lintstagedrc

@@ -1,3 +1,3 @@
 {
-  "*{.js,.ts}": ["eslint"]
+  "*{.js,.ts}": ["eslint --fix"]
 }

actions/README.md

@@ -0,0 +1,12 @@
+This folder contains GitHub Actions commonly used in some of our repositories.
+
+You can use them in your workflows as such:
+
+```yaml
+- name: Check licenses 🧪
+  uses: vuestorefront/vue-storefront/actions/check-licenses@main
+  with:
+  projectPath: ${{ github.workspace }}
+```
+
+If you're looking for Alokai code meant for users (you), see the `packages/*` folder

actions/check-licenses/.eslintignore

@@ -0,0 +1,2 @@
+lib
+dist

actions/check-licenses/.eslintrc.cjs

@@ -0,0 +1,3 @@
+module.exports = {
+  extends: ["@vue-storefront/eslint-config"],
+};

actions/check-licenses/.prettierignore

@@ -0,0 +1,5 @@
+# Ignore artifacts:
+build
+dist
+lib
+coverage

actions/check-licenses/README.MD

@@ -0,0 +1,25 @@
+# @vue-storefront/check-licenses
+
+> This action analyses software licenses for used dependencies in the project
+
+
+## Inputs
+
+### `projectPath`
+
+**Required** The path to the project root directory
+
+## Example usage
+
+```yaml
+uses: vuestorefront/vue-storefront/actions/check-licenses@main
+with:
+  projectPath: ${{ github.workspace }}
+```
+
+### Deployment
+
+1. Run `build` command to create GitHub actions distribution
+2. Update `package.json` version property
+3. Commit `dist` directory
+4. Create Git tag and push changes

actions/check-licenses/action.yml

@@ -0,0 +1,9 @@
+name: Check licenses
+description: Analyses software licenses of dependencies used in the project
+inputs:
+  projectPath:
+    description: The path to the project root directory
+    required: true
+runs:
+  using: "node20"
+  main: "dist/index.js"

actions/check-licenses/lint-staged.config.mjs

@@ -0,0 +1,3 @@
+export default {
+  "*.{js,ts}": ["eslint --fix", "prettier --write"],
+};

actions/check-licenses/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@vue-storefront/check-licenses",
+  "version": "1.0.7",
+  "private": true,
+  "homepage": "https://github.com/vuestorefront/vue-storefront/actions/check-licenses",
+  "main": "lib/index.js",
+  "prettier": "@vue-storefront/prettier-config",
+  "contributors": [
+    {
+      "name": "Maciej Rybaniec",
+      "email": "mrybaniec@vuestorefront.io"
+    }
+  ],
+  "scripts": {
+    "format": "prettier --write .",
+    "package": "ncc build --license licenses.txt --no-source-map-register",
+    "compile": "tsc",
+    "lint": "eslint --fix .",
+    "build": "yarn compile && yarn package"
+  },
+  "keywords": [
+    "license-checker"
+  ],
+  "dependencies": {
+    "@actions/core": "^1.10.0",
+    "@actions/github": "^5.1.1",
+    "license-checker-rseidelsohn": "^3.3.0"
+  },
+  "devDependencies": {
+    "@vercel/ncc": "^0.36.1"
+  }
+}

actions/check-licenses/src/index.ts

@@ -0,0 +1,32 @@
+/* eslint-disable unicorn/prefer-top-level-await */
+import * as core from '@actions/core';
+import checker from 'license-checker-rseidelsohn';
+
+import { ALLOWED_LICENSES } from './licenses';
+import { EXCLUDE_NPM_PACKAGES } from './npmPackages';
+
+async function run(): Promise<void> {
+  const projectPath = core.getInput('projectPath');
+  try {
+    core.info(`Checking licenses: --projectPath ${projectPath}`);
+    checker.init(
+      {
+        start: projectPath,
+        summary: true,
+        excludePackagesStartingWith: EXCLUDE_NPM_PACKAGES.join(';'),
+        onlyAllow: ALLOWED_LICENSES.join(';'),
+      },
+      (error, packages) => {
+        // @ts-expect-error: the library definition is wrong
+        core.info(checker.asSummary(packages));
+        if (error) {
+          core.setFailed(error.message);
+        }
+      },
+    );
+  } catch (error) {
+    core.setFailed(error.message);
+  }
+}
+
+run();

actions/check-licenses/src/licenses.ts

@@ -0,0 +1,40 @@
+export const ALLOWED_LICENSES = [
+  'Artistic-2.0',
+  'Apache-2.0',
+  // https://github.com/gtanner/qrcode-terminal/pull/45#issuecomment-1661985667
+  // Invalid non-SPDX identifier used by qrcode-terminal
+  'Apache 2.0',
+  'BSD-2-Clause',
+  'BSD-3-Clause',
+  'BSD*',
+  'Boost',
+  'BlueOak-1.0.0',
+  'CC-BY-3.0',
+  'CC0-1.0',
+  'CNRI',
+  'Custom: http://www.commonjs.org/',
+  'Custom: https://docs.vuestorefront.io/',
+  'Custom: https://nuxtjs.org',
+  'CC-BY-4.0',
+  'ISC',
+  'MIT',
+  'Miros',
+  'Multics',
+  'Naumen',
+  'NTP',
+  'UNKNOWN',
+  'Unicode',
+  'Unlicense',
+  'UNLICENSED',
+  'Universal',
+  'Lucent',
+  'LGPL-3.0',
+  'Open',
+  '0BSD',
+  'OBSD',
+  'PostgreSQ',
+  'Public Domain',
+  'Python-2.0',
+  'Zope',
+  'WTFPL',
+];

actions/check-licenses/src/npmPackages.ts

@@ -0,0 +1 @@
+export const EXCLUDE_NPM_PACKAGES = ['webpack', '@types', '@babel', 'k6'];

actions/check-licenses/tsconfig.json

@@ -0,0 +1,12 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "compilerOptions": {
+    "target": "esnext",
+    "module": "commonjs",
+    "outDir": "./lib",
+    "rootDir": "./src",
+    "noImplicitAny": true,
+    "esModuleInterop": true
+  },
+  "exclude": ["node_modules", "**/*.test.ts"]
+}

actions/circular-dependencies/.eslintignore

@@ -0,0 +1,2 @@
+lib
+dist

actions/circular-dependencies/.eslintrc.cjs

@@ -0,0 +1,3 @@
+module.exports = {
+  extends: ["@vue-storefront/eslint-config"],
+};

actions/circular-dependencies/.prettierignore

@@ -0,0 +1,5 @@
+# Ignore artifacts:
+build
+dist
+lib
+coverage

actions/circular-dependencies/README.MD

@@ -0,0 +1,24 @@
+# @vue-storefront/circular-dependencies
+
+> This action detects circular dependencies in the project
+
+## Inputs
+
+### `filesPath`
+
+**Required** The path to project files that will be used during analysis
+
+## Example usage
+
+```yaml
+uses: vuestorefront/vue-storefront/actions/circular-dependencies@main
+with:
+  filesPath: 'packages/**/*.{ts,vue}'
+```
+
+### Deployment
+
+1. Run `build` command to create GitHub actions distribution
+2. Update `package.json` version property
+3. Commit `dist` directory
+4. Create Git tag and push changes

actions/circular-dependencies/action.yml

@@ -0,0 +1,9 @@
+name: Circular dependencies
+description: Static circular dependency analyzer
+inputs:
+  filesPath:
+    description: The path to project files that will be used during analysis
+    required: true
+runs:
+  using: "node20"
+  main: "dist/index.js"

actions/circular-dependencies/lint-staged.config.mjs

@@ -0,0 +1,3 @@
+export default {
+  "*.{js,ts}": ["eslint --fix", "prettier --write"],
+};

actions/circular-dependencies/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@vue-storefront/circular-dependencies",
+  "version": "1.0.6",
+  "private": true,
+  "homepage": "https://github.com/vuestorefront/vue-storefront/actions/circular-dependencies",
+  "main": "lib/index.js",
+  "prettier": "@vue-storefront/prettier-config",
+  "contributors": [
+    {
+      "name": "Maciej Rybaniec",
+      "email": "mrybaniec@vuestorefront.io"
+    }
+  ],
+  "scripts": {
+    "format": "prettier --write .",
+    "package": "ncc build --license licenses.txt --no-source-map-register",
+    "compile": "tsc",
+    "lint": "eslint --fix .",
+    "build": "yarn compile && yarn package"
+  },
+  "keywords": [
+    "circular-dependency",
+    "dpdm"
+  ],
+  "dependencies": {
+    "@actions/core": "^1.10.0",
+    "@actions/github": "^5.1.1",
+    "dpdm": "^3.13.0"
+  },
+  "devDependencies": {
+    "@vercel/ncc": "^0.36.1",
+    "typescript": "^5.0.3"
+  }
+}

actions/circular-dependencies/src/index.ts

@@ -0,0 +1,22 @@
+/* eslint-disable unicorn/prefer-top-level-await */
+import * as core from '@actions/core';
+import { parseDependencyTree, parseCircular, prettyCircular } from 'dpdm';
+
+async function run(): Promise<void> {
+  try {
+    const filesPath = core.getInput('filesPath');
+    const tree = await parseDependencyTree(filesPath, {});
+    const circulars = parseCircular(tree);
+
+    if (circulars.length > 0) {
+      core.warning(`Detected ${circulars.length} circular dependencies between the files`);
+      core.info(prettyCircular(circulars));
+    } else {
+      core.info('No circular dependencies');
+    }
+  } catch (error) {
+    core.setFailed(error.message);
+  }
+}
+
+run();

actions/circular-dependencies/tsconfig.json

@@ -0,0 +1,12 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "compilerOptions": {
+    "target": "esnext",
+    "module": "commonjs",
+    "outDir": "./lib",
+    "rootDir": "./src",
+    "noImplicitAny": true,
+    "esModuleInterop": true
+  },
+  "exclude": ["node_modules", "**/*.test.ts"]
+}

engineering-toolkit/README.MD

@@ -0,0 +1 @@
+This folder contains configuration for tools commonly used across our repositories. If you're looking for Alokai code meant for users (you), see the `packages/*` folder

engineering-toolkit/api-extractor-config/CHANGELOG.md

@@ -0,0 +1,7 @@
+# @vue-storefront/api-extractor-config
+
+## 0.0.5
+
+### Patch Changes
+
+- d606385: Add api-documenter and api-extrator to dependencies

engineering-toolkit/api-extractor-config/README.MD

@@ -0,0 +1,47 @@
+# @vue-storefront/api-extractor-config
+
+> Common API Extractor configuration for Alokai Integrations
+
+## Usage
+
+### Install
+
+```bash
+yarn add -D @vue-storefront/api-extractor-config
+```
+
+### Package configuration
+
+First, you need a configuration file in your package root:
+
+```json
+{
+  "extends": "@vue-storefront/api-extractor-config",
+  "mainEntryPointFilePath": "./lib/api-extractor-data.d.ts",
+  "projectFolder": ".",
+  "compiler": {
+    "tsconfigFilePath": "<projectFolder>/tsconfig.json"
+  },
+  "dtsRollup": {
+    "untrimmedFilePath": "./lib/<unscopedPackageName>.d.ts"
+  },
+  "docModel": {
+    "apiJsonFilePath": "<projectFolder>/../../docs/reference/api/<unscopedPackageName>.api.json"
+  }
+}
+```
+
+This configuration assumes, that you have also a file `src/api-extractor-data.ts` in your project that exports the API definitions:
+
+```ts
+/**
+ * Package documentation description.
+ *
+ * @packageDocumentation
+ */
+
+export * from "./types";
+// etc...
+```
+
+`mainEntryPointFilePath` points to `lib`, so you need to build your package before running API Extractor.