@pezkuwi/dev 0.84.2

package/config/eslint.rules.js

@@ -0,0 +1,214 @@
+// Copyright 2017-2025 @polkadot/dev authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+import JSON5 from 'json5';
+import fs from 'node:fs';
+import path from 'node:path';
+import process from 'node:process';
+
+const FIXME = {
+  // This is in the new 6.0.0 and we should switch this on
+  // at some point. For a first iteration we keep as-is
+  '@typescript-eslint/prefer-nullish-coalescing': 'off'
+};
+
+/**
+ * Returns a copyright header pattern (using tsconfig.base.json)
+ *
+ * @returns {string}
+ */
+function getHeaderPattern () {
+  const tsPath = path.join(process.cwd(), 'tsconfig.base.json');
+
+  if (!fs.existsSync(tsPath)) {
+    throw new Error(`Unable to load ${tsPath}`);
+  }
+
+  const tsConfig = JSON5.parse(fs.readFileSync(tsPath, 'utf-8'));
+
+  if (!tsConfig?.compilerOptions?.paths) {
+    throw new Error(`Unable to extract compilerOptions.paths structure from ${tsPath}`);
+  }
+
+  const paths = Object.keys(tsConfig.compilerOptions.paths);
+
+  if (!paths.length) {
+    throw new Error(`No keys found in compilerOptions.paths from ${tsPath}`);
+  }
+
+  const packages = paths.reduce((packages, k) => {
+    const [pd, pk] = k.split('/');
+
+    if (pd !== '@polkadot' || !pk) {
+      throw new Error(`Non @polkadot path in ${tsPath}`);
+    }
+
+    return packages.length
+      ? `${packages}|${pk}`
+      : pk;
+  }, '');
+  const fullyear = new Date().getFullYear();
+  const years = [];
+
+  for (let i = 17, last = fullyear - 2000; i < last; i++) {
+    years.push(`${i}`);
+  }
+
+  return ` Copyright 20(${years.join('|')})(-${fullyear})? @polkadot/(${packages})`;
+}
+
+export const overrideAll = {
+  ...FIXME,
+  // the next 2 enforce isolatedModules & verbatimModuleSyntax
+  '@typescript-eslint/consistent-type-exports': 'error',
+  '@typescript-eslint/consistent-type-imports': 'error',
+  '@typescript-eslint/dot-notation': 'error',
+  '@typescript-eslint/indent': ['error', 2],
+  '@typescript-eslint/no-non-null-assertion': 'error',
+  // ts itself checks and ignores those starting with _, align the linting
+  '@typescript-eslint/no-unused-vars': ['error', {
+    args: 'all',
+    argsIgnorePattern: '^_',
+    caughtErrors: 'all',
+    caughtErrorsIgnorePattern: '^_',
+    destructuredArrayIgnorePattern: '^_',
+    vars: 'all',
+    varsIgnorePattern: '^_'
+  }],
+  '@typescript-eslint/type-annotation-spacing': 'error',
+  'arrow-parens': ['error', 'always'],
+  'brace-style': ['error', '1tbs'],
+  curly: ['error', 'all'],
+  'default-param-last': 'off', // conflicts with TS version
+  'deprecation/deprecation': 'error',
+  'dot-notation': 'off', // conflicts with TS version
+  'func-style': ['error', 'declaration', {
+    allowArrowFunctions: true
+  }],
+  // this does help with declarations, but also
+  // applies to invocations, which is an issue...
+  // 'function-paren-newline': ['error', 'never'],
+  'function-call-argument-newline': ['error', 'consistent'],
+  'header/header': ['error', 'line', [
+    { pattern: getHeaderPattern() },
+    ' SPDX-License-Identifier: Apache-2.0'
+  ], 2],
+  'import-newlines/enforce': ['error', {
+    forceSingleLine: true,
+    items: 2048
+  }],
+  'import/export': 'error',
+  'import/extensions': ['error', 'ignorePackages', {
+    cjs: 'always',
+    js: 'always',
+    json: 'always',
+    jsx: 'never',
+    mjs: 'always',
+    ts: 'never',
+    tsx: 'never'
+  }],
+  'import/first': 'error',
+  'import/newline-after-import': 'error',
+  'import/no-duplicates': 'error',
+  'import/order': 'off', // conflicts with simple-import-sort
+  indent: 'off', // required as 'off' since typescript-eslint has own versions
+  'no-extra-semi': 'error',
+  'no-unused-vars': 'off',
+  'no-use-before-define': 'off',
+  'object-curly-newline': ['error', {
+    ExportDeclaration: { minProperties: 2048 },
+    ImportDeclaration: { minProperties: 2048 },
+    ObjectPattern: { minProperties: 2048 }
+  }],
+  'padding-line-between-statements': [
+    'error',
+    { blankLine: 'always', next: '*', prev: ['const', 'let', 'var'] },
+    { blankLine: 'any', next: ['const', 'let', 'var'], prev: ['const', 'let', 'var'] },
+    { blankLine: 'always', next: 'block-like', prev: '*' },
+    { blankLine: 'always', next: '*', prev: 'block-like' },
+    { blankLine: 'always', next: 'function', prev: '*' },
+    { blankLine: 'always', next: '*', prev: 'function' },
+    { blankLine: 'always', next: 'try', prev: '*' },
+    { blankLine: 'always', next: '*', prev: 'try' },
+    { blankLine: 'always', next: 'return', prev: '*' },
+    { blankLine: 'always', next: 'import', prev: '*' },
+    { blankLine: 'always', next: '*', prev: 'import' },
+    { blankLine: 'any', next: 'import', prev: 'import' }
+  ],
+  semi: ['error', 'always'],
+  'simple-import-sort/exports': 'error',
+  'simple-import-sort/imports': ['error', {
+    groups: [
+      ['^\u0000'], // all side-effects (0 at start)
+      ['\u0000$', '^@polkadot.*\u0000$', '^\\..*\u0000$'], // types (0 at end)
+      // ['^node:'], // node
+      ['^[^/\\.]'], // non-polkadot
+      ['^@polkadot'], // polkadot
+      ['^\\.\\.(?!/?$)', '^\\.\\./?$', '^\\./(?=.*/)(?!/?$)', '^\\.(?!/?$)', '^\\./?$'] // local (. last)
+    ]
+  }],
+  'sort-destructure-keys/sort-destructure-keys': ['error', {
+    caseSensitive: true
+  }],
+  'sort-keys': 'error',
+  'spaced-comment': ['error', 'always', {
+    block: {
+      // pure export helpers
+      markers: ['#__PURE__']
+    },
+    line: {
+      // TS reference types
+      markers: ['/ <reference']
+    }
+  }]
+};
+
+export const overrideJsx = {
+  'jsx-quotes': ['error', 'prefer-single'],
+  // swap from recommended warning to error
+  'react-hooks/exhaustive-deps': 'error',
+  'react/jsx-closing-bracket-location': ['warn', 'tag-aligned'],
+  'react/jsx-first-prop-new-line': ['warn', 'multiline-multiprop'],
+  'react/jsx-fragments': 'error',
+  'react/jsx-max-props-per-line': ['warn', {
+    maximum: 1,
+    when: 'always'
+  }],
+  'react/jsx-newline': ['error', {
+    prevent: true
+  }],
+  'react/jsx-no-bind': 'error',
+  'react/jsx-props-no-multi-spaces': 'error',
+  'react/jsx-sort-props': ['warn', {
+    noSortAlphabetically: false
+  }],
+  'react/jsx-tag-spacing': ['error', {
+    afterOpening: 'never',
+    beforeClosing: 'never',
+    beforeSelfClosing: 'always',
+    closingSlash: 'never'
+  }],
+  'react/prop-types': 'off' // this is a completely broken rule
+};
+
+export const overrideJs = {
+  '@typescript-eslint/explicit-function-return-type': 'off',
+  '@typescript-eslint/no-unsafe-argument': 'off',
+  '@typescript-eslint/no-unsafe-assignment': 'off',
+  '@typescript-eslint/no-unsafe-call': 'off',
+  '@typescript-eslint/no-unsafe-member-access': 'off',
+  '@typescript-eslint/no-unsafe-return': 'off',
+  '@typescript-eslint/no-var-requires': 'off',
+  '@typescript-eslint/restrict-plus-operands': 'off',
+  '@typescript-eslint/restrict-template-expressions': 'off'
+};
+
+export const overrideSpec = {
+  // in the specs we are a little less worried about
+  // specific correctness, i.e. we can have dangling bits
+  '@typescript-eslint/no-unsafe-call': 'off',
+  '@typescript-eslint/no-unsafe-member-access': 'off',
+  'jest/expect-expect': ['warn', {
+    assertFunctionNames: ['assert', 'expect']
+  }]
+};

package/config/prettier.cjs

@@ -0,0 +1,22 @@
+// Copyright 2017-2025 @polkadot/dev authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+module.exports = {
+  arrowParens: 'always',
+  bracketSpacing: true,
+  embeddedLanguageFormatting: 'off',
+  endOfLine: 'lf',
+  htmlWhitespaceSensitivity: 'ignore',
+  jsxBracketSameLine: false,
+  jsxSingleQuote: true,
+  parser: 'typescript',
+  printWidth: 2048,
+  proseWrap: 'preserve',
+  quoteProps: 'as-needed',
+  requirePragma: true, // only on those files explicitly asked for
+  semi: true,
+  singleQuote: true,
+  tabWidth: 2,
+  trailingComma: 'none',
+  useTabs: false
+};

package/config/rollup.js

@@ -0,0 +1,113 @@
+// Copyright 2017-2025 @polkadot/dev authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+import pluginAlias from '@rollup/plugin-alias';
+import pluginCommonjs from '@rollup/plugin-commonjs';
+import pluginDynamicImportVars from '@rollup/plugin-dynamic-import-vars';
+import pluginInject from '@rollup/plugin-inject';
+import pluginJson from '@rollup/plugin-json';
+import { nodeResolve as pluginResolve } from '@rollup/plugin-node-resolve';
+import fs from 'node:fs';
+import path from 'node:path';
+import pluginCleanup from 'rollup-plugin-cleanup';
+
+/** @typedef {{ entries?: Record<string, string>; external: string[]; globals?: Record<string, string>; index?: string; inject?: Record<string, string>; pkg: string; }} BundleDef */
+/** @typedef {{ file: string; format: 'umd'; generatedCode: Record<string, unknown>; globals: Record<string, string>; inlineDynamicImports: true; intro: string; name: string; }} BundleOutput */
+/** @typedef {{ context: 'global'; external: string[]; input: string; output: BundleOutput; plugins: any[]; }} Bundle */
+
+/**
+ * @param {string} pkg
+ * @returns {string}
+ */
+function sanitizePkg (pkg) {
+  return pkg.replace('@polkadot/', '');
+}
+
+/**
+ * @param {string} input
+ * @returns {string}
+ */
+function createName (input) {
+  return `polkadot-${sanitizePkg(input)}`
+    .toLowerCase()
+    .replace(/[^a-zA-Z0-9]+(.)/g, (_, c) => c.toUpperCase());
+}
+
+/**
+ * @param {string} pkg
+ * @param {string} [index]
+ * @returns {string}
+ */
+export function createInput (pkg, index) {
+  const partialPath = `packages/${sanitizePkg(pkg)}/build`;
+
+  return `${partialPath}/${
+    index ||
+    fs.existsSync(path.join(process.cwd(), partialPath, 'bundle.js'))
+      ? 'bundle.js'
+      : (
+        JSON.parse(fs.readFileSync(path.join(process.cwd(), partialPath, 'package.json'), 'utf8')).browser ||
+        'index.js'
+      )
+  }`;
+}
+
+/**
+ *
+ * @param {string} pkg
+ * @param {string[]} external
+ * @param {Record<string, string>} globals
+ * @returns {BundleOutput}
+ */
+export function createOutput (pkg, external, globals) {
+  const name = sanitizePkg(pkg);
+
+  return {
+    file: `packages/${name}/build/bundle-polkadot-${name}.js`,
+    format: 'umd',
+    generatedCode: {
+      constBindings: true
+    },
+    globals: external.reduce((all, p) => ({
+      [p]: createName(p),
+      ...all
+    }), { ...globals }),
+    // combine multi-chunk builds with dynamic imports
+    inlineDynamicImports: true,
+    // this is a mini x-global, determine where our context lies
+    intro: 'const global = typeof globalThis !== "undefined" ? globalThis : typeof self !== "undefined" ? self : window;',
+    name: createName(pkg)
+  };
+}
+
+/**
+ *
+ * @param {BundleDef} param0
+ * @returns {Bundle}
+ */
+export function createBundle ({ entries = {}, external, globals = {}, index, inject = {}, pkg }) {
+  return {
+    // specify this (we define global in the output intro as globalThis || self || window)
+    context: 'global',
+    external,
+    input: createInput(pkg, index),
+    output: createOutput(pkg, external, globals),
+    // NOTE The expect-error directives are due to rollup plugins, see
+    // - https://github.com/rollup/plugins/issues/1488
+    // - https://github.com/rollup/plugins/issues/1329
+    plugins: [
+      // @ts-expect-error See the linked rollup issues above
+      pluginAlias({ entries }),
+      // @ts-expect-error See the linked rollup issues above
+      pluginJson(),
+      // @ts-expect-error See the linked rollup issues above
+      pluginCommonjs(),
+      // @ts-expect-error See the linked rollup issues above
+      pluginDynamicImportVars(),
+      // @ts-expect-error See the linked rollup issues above
+      pluginInject(inject),
+      pluginResolve({ browser: true }),
+      pluginCleanup()
+    ]
+  };
+}

package/config/tsconfig.json

@@ -0,0 +1,32 @@
+{
+  /**
+   * There uses the strictest configs as the base
+   * https://github.com/tsconfig/bases/blob/f674fa6cbca17062ff02511b02872f8729a597ec/bases/strictest.json
+   */
+  "extends": "@tsconfig/strictest/tsconfig.json",
+  "compilerOptions": {
+    /**
+     * Aligns with packages/dev/scripts/polkadot-dev-build-ts & packages/dev-ts/src/loader
+     * (target here is specifically tied to the minimum supported Node version)
+     */
+    "module": "nodenext",
+    "moduleResolution": "nodenext",
+    "target": "es2022",
+
+    /**
+     * Specific compilation configs for polkadot-js projects as it is used
+     * (we only compile *.d.ts via the tsc command-line)
+     */
+    "declaration": true,
+    "emitDeclarationOnly": true,
+    "jsx": "preserve",
+    "verbatimModuleSyntax": true,
+
+    /**
+     * These appear in strictest, however we don't (yet) use them. For the most part it means
+     * that we actually do have a large number of these lurking (especially on index checks)
+     */
+    "exactOptionalPropertyTypes": false,
+    "noUncheckedIndexedAccess": false,
+  }
+}

package/config/typedoc.cjs

@@ -0,0 +1,18 @@
+// Copyright 2017-2025 @polkadot/dev authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+module.exports = {
+  exclude: '**/*+(index|e2e|spec|types).ts',
+  excludeExternals: true,
+  excludeNotExported: true,
+  excludePrivate: true,
+  excludeProtected: true,
+  hideGenerator: true,
+  includeDeclarations: false,
+  module: 'commonjs',
+  moduleResolution: 'node',
+  name: 'polkadot{.js}',
+  out: 'docs',
+  stripInternal: 'true',
+  theme: 'markdown'
+};

package/package.json

@@ -0,0 +1,107 @@
+{
+  "author": "Jaco Greeff <jacogr@gmail.com>",
+  "bugs": "https://github.com/pezkuwi/dev/issues",
+  "description": "A collection of shared CI scripts and development environment used by @pezkuwi projects",
+  "engines": {
+    "node": ">=18"
+  },
+  "homepage": "https://github.com/pezkuwi/dev/tree/master/packages/dev#readme",
+  "license": "Apache-2.0",
+  "name": "@pezkuwi/dev",
+  "repository": {
+    "directory": "packages/dev",
+    "type": "git",
+    "url": "https://github.com/pezkuwi/dev.git"
+  },
+  "sideEffects": false,
+  "type": "module",
+  "version": "0.84.2",
+  "bin": {
+    "polkadot-ci-ghact-build": "./scripts/polkadot-ci-ghact-build.mjs",
+    "polkadot-ci-ghact-docs": "./scripts/polkadot-ci-ghact-docs.mjs",
+    "polkadot-ci-ghpages-force": "./scripts/polkadot-ci-ghpages-force.mjs",
+    "polkadot-dev-build-docs": "./scripts/polkadot-dev-build-docs.mjs",
+    "polkadot-dev-build-ts": "./scripts/polkadot-dev-build-ts.mjs",
+    "polkadot-dev-circular": "./scripts/polkadot-dev-circular.mjs",
+    "polkadot-dev-clean-build": "./scripts/polkadot-dev-clean-build.mjs",
+    "polkadot-dev-contrib": "./scripts/polkadot-dev-contrib.mjs",
+    "polkadot-dev-copy-dir": "./scripts/polkadot-dev-copy-dir.mjs",
+    "polkadot-dev-copy-to": "./scripts/polkadot-dev-copy-to.mjs",
+    "polkadot-dev-deno-map": "./scripts/polkadot-dev-deno-map.mjs",
+    "polkadot-dev-run-lint": "./scripts/polkadot-dev-run-lint.mjs",
+    "polkadot-dev-run-node-ts": "./scripts/polkadot-dev-run-node-ts.mjs",
+    "polkadot-dev-run-test": "./scripts/polkadot-dev-run-test.mjs",
+    "polkadot-dev-version": "./scripts/polkadot-dev-version.mjs",
+    "polkadot-dev-yarn-only": "./scripts/polkadot-dev-yarn-only.mjs",
+    "polkadot-exec-eslint": "./scripts/polkadot-exec-eslint.mjs",
+    "polkadot-exec-ghpages": "./scripts/polkadot-exec-ghpages.mjs",
+    "polkadot-exec-ghrelease": "./scripts/polkadot-exec-ghrelease.mjs",
+    "polkadot-exec-node-test": "./scripts/polkadot-exec-node-test.mjs",
+    "polkadot-exec-rollup": "./scripts/polkadot-exec-rollup.mjs",
+    "polkadot-exec-tsc": "./scripts/polkadot-exec-tsc.mjs",
+    "polkadot-exec-webpack": "./scripts/polkadot-exec-webpack.mjs"
+  },
+  "exports": {
+    "./config/eslint": "./config/eslint.js",
+    "./config/prettier.cjs": "./config/prettier.cjs",
+    "./config/tsconfig.json": "./config/tsconfig.json",
+    "./rootJs/dynamic.mjs": "./src/rootJs/dynamic.mjs",
+    "./rootJs/testJson.json": "./src/rootJs/testJson.json"
+  },
+  "dependencies": {
+    "@eslint/js": "^8.56.0",
+    "@pezkuwi/dev-test": "^0.84.2",
+    "@pezkuwi/dev-ts": "^0.84.2",
+    "@rollup/plugin-alias": "^5.1.1",
+    "@rollup/plugin-commonjs": "^25.0.8",
+    "@rollup/plugin-dynamic-import-vars": "^2.1.5",
+    "@rollup/plugin-inject": "^5.0.5",
+    "@rollup/plugin-json": "^6.1.0",
+    "@rollup/plugin-node-resolve": "^15.3.1",
+    "@tsconfig/strictest": "^2.0.2",
+    "@typescript-eslint/eslint-plugin": "^6.19.1",
+    "@typescript-eslint/parser": "^6.19.1",
+    "eslint": "^8.56.0",
+    "eslint-config-standard": "^17.1.0",
+    "eslint-import-resolver-node": "^0.3.9",
+    "eslint-import-resolver-typescript": "^3.6.1",
+    "eslint-plugin-deprecation": "^2.0.0",
+    "eslint-plugin-header": "^3.1.1",
+    "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-import-newlines": "^1.3.4",
+    "eslint-plugin-jest": "^27.6.3",
+    "eslint-plugin-n": "^16.6.2",
+    "eslint-plugin-promise": "^6.1.1",
+    "eslint-plugin-react": "^7.33.2",
+    "eslint-plugin-react-hooks": "^4.6.0",
+    "eslint-plugin-simple-import-sort": "^10.0.0",
+    "eslint-plugin-sort-destructure-keys": "^1.5.0",
+    "espree": "^9.6.1",
+    "gh-pages": "^6.1.1",
+    "gh-release": "^7.0.2",
+    "globals": "^13.24.0",
+    "json5": "^2.2.3",
+    "madge": "^6.1.0",
+    "rollup": "^4.9.6",
+    "rollup-plugin-cleanup": "^3.2.1",
+    "tslib": "^2.7.0",
+    "typescript": "^5.5.4",
+    "webpack": "^5.89.0",
+    "webpack-cli": "^5.1.4",
+    "webpack-dev-server": "^4.15.1",
+    "webpack-merge": "^5.10.0",
+    "webpack-subresource-integrity": "^5.2.0-rc.1",
+    "yargs": "^17.7.2"
+  },
+  "devDependencies": {
+    "@testing-library/react": "^14.1.2",
+    "@types/node": "^20.11.5",
+    "@types/react": "^18.2.48",
+    "@types/react-dom": "^18.2.18",
+    "@types/yargs": "^17.0.32",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
+    "react-is": "^18.2.0",
+    "styled-components": "^6.1.8"
+  }
+}