declapract-typescript-ehmpathy 0.42.5 → 0.43.0

package/dist/practices/format/bad-practices/prettier/.declapract.readme.md

@@ -0,0 +1,6 @@
+Prettier is no longer used - biome or other tools are preferred. This bad practice removes:
+
+- prettier.config.js
+- .prettierignore
+- prettier and @trivago/prettier-plugin-sort-imports devDependencies
+- fix:format:prettier and test:format:prettier scripts

package/dist/practices/{prettier/best-practice → format/bad-practices/prettier}/.prettierignore

@@ -1,2 +1,3 @@
 *.md
 .yalc/
+dist/

package/dist/practices/format/bad-practices/prettier/.prettierignore.declapract.ts

@@ -0,0 +1,8 @@
+import { FileCheckType, FileFixFunction } from 'declapract';
+
+export const check = FileCheckType.EXISTS;
+
+export const fix: FileFixFunction = () => {
+  // Remove the file by returning null contents
+  return { contents: null };
+};

package/dist/practices/format/bad-practices/prettier/package.json.declapract.ts

@@ -0,0 +1,35 @@
+import { FileCheckType, FileFixFunction } from 'declapract';
+
+export const check = FileCheckType.CONTAINS;
+
+const depsToRemove = ['prettier', '@trivago/prettier-plugin-sort-imports'];
+
+const scriptsToRemove = ['fix:format:prettier', 'test:format:prettier'];
+
+export const fix: FileFixFunction = (contents) => {
+  if (!contents) return { contents };
+
+  const packageJSON = JSON.parse(contents);
+
+  // Remove prettier devDependencies
+  const updatedDevDeps = { ...packageJSON.devDependencies };
+  for (const dep of depsToRemove) {
+    delete updatedDevDeps[dep];
+  }
+
+  // Remove prettier scripts
+  const updatedScripts = { ...packageJSON.scripts };
+  for (const script of scriptsToRemove) {
+    delete updatedScripts[script];
+  }
+
+  const fixedPackageJSON = {
+    ...packageJSON,
+    devDependencies:
+      Object.keys(updatedDevDeps).length > 0 ? updatedDevDeps : undefined,
+    scripts:
+      Object.keys(updatedScripts).length > 0 ? updatedScripts : undefined,
+  };
+
+  return { contents: JSON.stringify(fixedPackageJSON, null, 2) };
+};

package/dist/practices/format/bad-practices/prettier/prettier.config.js.declapract.ts

@@ -0,0 +1,8 @@
+import { FileCheckType, FileFixFunction } from 'declapract';
+
+export const check = FileCheckType.EXISTS;
+
+export const fix: FileFixFunction = () => {
+  // Remove the file by returning null contents
+  return { contents: null };
+};

package/dist/practices/format/best-practice/package.json.declapract.ts

@@ -6,7 +6,7 @@ import { isPresent } from 'type-fns';
  */
 export const contents: FileContentsFunction = (context) => {
   const formatters = [
-    'prettier',
+    'biome',
     context.projectPractices.includes('terraform') ? 'terraform' : null, // only include the terraform formatter if terraform practice is used
   ].filter(isPresent);
 

package/dist/practices/lint/bad-practices/depcheck-denylisted-ignores/.depcheckrc.yml.declapract.ts

@@ -9,6 +9,8 @@ const denylist = [
   'ts-jest',
   'core-js',
   'babel-jest',
+  '@trivago/prettier-plugin-sort-imports',
+  '@tsconfig/node-lts-strictest',
 ];
 
 export const check: FileCheckFunction = (contents) => {

package/dist/practices/lint/bad-practices/eslint/.eslintrc.js.declapract.ts

@@ -0,0 +1,3 @@
+import { FileCheckType, FileFixFunction } from 'declapract';
+
+export const check = FileCheckType.EXISTS;

package/dist/practices/lint/bad-practices/eslint/package.json.declapract.ts

@@ -0,0 +1,51 @@
+import { FileCheckFunction, FileFixFunction } from 'declapract';
+
+const depsBlocklist = [
+  '@typescript-eslint/eslint-plugin',
+  '@typescript-eslint/parser',
+  'eslint',
+  'eslint-config-airbnb-typescript',
+  'eslint-config-prettier',
+  'eslint-plugin-import',
+  'eslint-plugin-prettier',
+  'eslint-plugin-unused-imports',
+];
+
+const scriptsBlocklist = ['test:lint:eslint'];
+
+export const check: FileCheckFunction = (contents) => {
+  if (!contents) throw Error('does not match bad practice');
+  const packageJSONObject = JSON.parse(contents);
+  const devDepsFound = Object.keys(packageJSONObject.devDependencies ?? {});
+  const scriptsFound = Object.keys(packageJSONObject.scripts ?? {});
+  if (
+    depsBlocklist.some((dep) => devDepsFound.includes(dep)) ||
+    scriptsBlocklist.some((script) => scriptsFound.includes(script))
+  )
+    return; // matches bad practice
+  throw new Error('does not match bad practice');
+};
+
+export const fix: FileFixFunction = (contents) => {
+  if (!contents) return {}; // should not occur
+  const packageJSONObject = JSON.parse(contents);
+
+  // Remove blocklisted devDependencies
+  const updatedDevDeps = { ...packageJSONObject.devDependencies };
+  for (const dep of depsBlocklist) {
+    delete updatedDevDeps[dep];
+  }
+
+  // Remove blocklisted scripts
+  const updatedScripts = { ...packageJSONObject.scripts };
+  for (const script of scriptsBlocklist) {
+    delete updatedScripts[script];
+  }
+
+  const fixedPackageJSONObject = {
+    ...packageJSONObject,
+    devDependencies: updatedDevDeps,
+    scripts: packageJSONObject.scripts ? updatedScripts : undefined,
+  };
+  return { contents: JSON.stringify(fixedPackageJSONObject, null, 2) };
+};

package/dist/practices/lint/best-practice/.declapract.readme.md

@@ -1,4 +1,4 @@
-# eslint
+# biome
 prevents bad practices and improves code quality
 
 # depcheck

package/dist/practices/lint/best-practice/.depcheckrc.yml

@@ -3,9 +3,11 @@ ignores:
   - declapract
   - declapract-typescript-ehmpathy
   - '@commitlint/config-conventional'
-  - '@trivago/prettier-plugin-sort-imports'
-  - '@tsconfig/node-lts-strictest'
-  - tsx
+  - '@tsconfig/node20'
+  - '@tsconfig/strictest'
+  - '@biomejs/biome'
+  - esbuild-register
+  - "@swc/core"
+  - "@swc/jest"
   - husky
-  - '@swc/core'
-  - '@swc/jest'
+  - tsx

package/dist/practices/lint/best-practice/package.json

@@ -1,19 +1,14 @@
 {
   "devDependencies": {
-    "@typescript-eslint/eslint-plugin": "7.8.0",
-    "@typescript-eslint/parser": "7.8.0",
-    "eslint": "8.56.0",
-    "eslint-config-airbnb-typescript": "18.0.0",
-    "eslint-config-prettier": "8.5.0",
-    "eslint-plugin-import": "2.26.0",
-    "eslint-plugin-prettier": "4.2.1",
-    "eslint-plugin-unused-imports": "4.1.4",
-    "depcheck": "1.4.3"
+    "depcheck": "1.4.3",
+    "@biomejs/biome": "2.3.8"
   },
   "scripts": {
-    "fix:lint": "eslint -c ./.eslintrc.js src/**/*.ts --fix",
-    "test:lint:eslint": "eslint -c ./.eslintrc.js src/**/*.ts",
+    "fix:format:biome": "biome check --write src",
+    "fix:lint": "biome check --write src",
+    "test:format:biome": "biome format src",
+    "test:lint:biome": "eslint -c ./.eslintrc.js src/**/*.ts",
     "test:lint:deps": "npx depcheck -c ./.depcheckrc.yml",
-    "test:lint": "npm run test:lint:eslint && npm run test:lint:deps"
+    "test:lint": "npm run test:lint:biome && npm run test:lint:deps"
   }
 }

package/dist/practices/package-json-order/best-practice/package.json.declapract.ts

@@ -23,6 +23,7 @@ export const desiredRelativeKeyOrder = {
   ],
   scripts: [
     'commit:with-cli',
+    'fix:format:biome',
     'fix:format:prettier',
     'fix:format:terraform',
     'fix:format',
@@ -55,6 +56,7 @@ export const desiredRelativeKeyOrder = {
     'test:format:terraform',
     'test:format',
     'test:lint:deps',
+    'test:lint:biome',
     'test:lint:eslint',
     'test:lint',
     'test:unit',

package/dist/practices/serverless/best-practice/serverless.yml

@@ -110,3 +110,8 @@ provider:
         - athena:GetQueryExecution
         - athena:GetQueryResults
       Resource: '*'
+    # allow inferring access from account alias
+    - Effect: Allow
+      Action:
+        - iam:ListAccountAliases
+      Resource: '*'

package/dist/practices/serverless/best-practice/serverless.yml.declapract.ts

@@ -3,40 +3,55 @@ import { FileFixFunction } from 'declapract/dist/domain';
 
 export const check = FileCheckType.CONTAINS; // i.e., check that the contents of the file contains what's declared (default is equals)
 
+const listAccountAliasesPolicy = `    # allow inferring access from account alias
+    - Effect: Allow
+      Action:
+        - iam:ListAccountAliases
+      Resource: '*'`;
+
 export const fix: FileFixFunction = (contents) => {
   if (!contents) return { contents }; // do nothing if file dne; // TODO: update to provision file from declared contents
-  return {
-    // TODO: when we have special support for yml, do this better (i.e., instead of string replace, just add to the yml object after parsing it)
-    contents: contents
-      .replace(/runtime\: nodejs\d\d.x/, 'runtime: nodejs16.x')
-      .replace(/  - serverless-offline .*\n/, '') // a plugin we no longer use (never used it, no need to have it)
-      .replace(/  - serverless-pseudo-parameters .*\n/, '') // a plugin we no longer use (serverless supports variables natively now)
-      .replace(/\#\{AWS\:\:Region\}/g, '${aws:region}') // use the serverless native variables, instead of the pseudo-parameters format
-      .replace(/\#\{AWS\:\:AccountId\}/g, '${aws:accountId}') // use the serverless native variables, instead of the pseudo-parameters format
-      .replace('## paramstore access', '# parameter store access')
-      .replace(
-        '## allow invocation of other lambdas',
-        '# allow invocation of other lambdas',
-      )
-      .replace(
-        'environment:\n    NODE_ENV:',
-        'environment:\n    TZ: UTC # guarantee that utc timezone will be used explicitly, to facilitate a pit of success\n    NODE_ENV:',
-      )
-      .replace(
-        'NODE_ENV: ${self:custom.stageToNodeEnvMapping.${self:provider.stage}}\n  deploymentBucket',
-        'NODE_ENV: ${self:custom.stageToNodeEnvMapping.${self:provider.stage}}\n    AWS_NODEJS_CONNECTION_REUSE_ENABLED: true # https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/node-reusing-connections.html\n  deploymentBucket',
-      ) // add this env flag
-      .replace(
-        /service: ([a-zA-Z0-9\-]+)\n\n?provider:/,
-        'service: $1\n\npackage:\n  artifact: .artifact/contents.zip\n\nprovider:',
-      )
-      .replace(
-        '  artifact: .artifact/contents.zip\n\nprovider:', // if no plugins at all
-        '  artifact: .artifact/contents.zip\n\nplugins:\n  - serverless-prune-plugin\n\nprovider:', // add the sls prune plugin
-      )
-      .replace(
-        '  timeout: 10',
-        '  timeout: 60 # default timeout to 1min, for resilience against increased cold start times; individual functions can override this', // bump the timeout
-      ),
-  };
+  let fixed = contents
+    .replace(/runtime\: nodejs\d\d.x/, 'runtime: nodejs16.x')
+    .replace(/  - serverless-offline .*\n/, '') // a plugin we no longer use (never used it, no need to have it)
+    .replace(/  - serverless-pseudo-parameters .*\n/, '') // a plugin we no longer use (serverless supports variables natively now)
+    .replace(/\#\{AWS\:\:Region\}/g, '${aws:region}') // use the serverless native variables, instead of the pseudo-parameters format
+    .replace(/\#\{AWS\:\:AccountId\}/g, '${aws:accountId}') // use the serverless native variables, instead of the pseudo-parameters format
+    .replace('## paramstore access', '# parameter store access')
+    .replace(
+      '## allow invocation of other lambdas',
+      '# allow invocation of other lambdas',
+    )
+    .replace(
+      'environment:\n    NODE_ENV:',
+      'environment:\n    TZ: UTC # guarantee that utc timezone will be used explicitly, to facilitate a pit of success\n    NODE_ENV:',
+    )
+    .replace(
+      'NODE_ENV: ${self:custom.stageToNodeEnvMapping.${self:provider.stage}}\n  deploymentBucket',
+      'NODE_ENV: ${self:custom.stageToNodeEnvMapping.${self:provider.stage}}\n    AWS_NODEJS_CONNECTION_REUSE_ENABLED: true # https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/node-reusing-connections.html\n  deploymentBucket',
+    ) // add this env flag
+    .replace(
+      /service: ([a-zA-Z0-9\-]+)\n\n?provider:/,
+      'service: $1\n\npackage:\n  artifact: .artifact/contents.zip\n\nprovider:',
+    )
+    .replace(
+      '  artifact: .artifact/contents.zip\n\nprovider:', // if no plugins at all
+      '  artifact: .artifact/contents.zip\n\nplugins:\n  - serverless-prune-plugin\n\nprovider:', // add the sls prune plugin
+    )
+    .replace(
+      '  timeout: 10',
+      '  timeout: 60 # default timeout to 1min, for resilience against increased cold start times; individual functions can override this', // bump the timeout
+    );
+
+  // Append ListAccountAliases policy if not already present
+  if (!fixed.includes('iam:ListAccountAliases')) {
+    if (/iamRoleStatements:\s*\n/.test(fixed)) {
+      fixed = fixed.replace(
+        /iamRoleStatements:\s*\n/,
+        `iamRoleStatements:\n${listAccountAliasesPolicy}\n`,
+      );
+    }
+  }
+
+  return { contents: fixed };
 };

package/dist/practices/tests/best-practice/jest.acceptance.config.ts

@@ -1,3 +1,6 @@
+/**
+ * @jest-config-loader esbuild-register
+ */
 import type { Config } from 'jest';
 
 // ensure tests run in utc, like they will on cicd and on server; https://stackoverflow.com/a/56277249/15593329

package/dist/practices/tests/best-practice/jest.config.ts

@@ -1,3 +1,6 @@
+/**
+ * @jest-config-loader esbuild-register
+ */
 import config from './jest.unit.config';
 
 // eslint-disable-next-line import/no-default-export

package/dist/practices/tests/best-practice/jest.integration.config.ts

@@ -1,3 +1,6 @@
+/**
+ * @jest-config-loader esbuild-register
+ */
 import type { Config } from 'jest';
 
 // ensure tests run in utc, like they will on cicd and on server; https://stackoverflow.com/a/56277249/15593329

package/dist/practices/tests/best-practice/jest.unit.config.ts

@@ -1,3 +1,6 @@
+/**
+ * @jest-config-loader esbuild-register
+ */
 import type { Config } from 'jest';
 
 // ensure tests run in utc, like they will on cicd and on server; https://stackoverflow.com/a/56277249/15593329

package/dist/practices/tests/best-practice/package.json

@@ -1,7 +1,8 @@
 {
   "devDependencies": {
-    "@types/jest": "@declapract{check.minVersion('29.2.4')}",
-    "jest": "@declapract{check.minVersion('29.3.1')}",
+    "@types/jest": "@declapract{check.minVersion('30.2.0')}",
+    "jest": "@declapract{check.minVersion('30.2.0')}",
+    "esbuild-register": "@declapract{check.minVersion('3.6.0')}",
     "test-fns": "@declapract{check.minVersion('1.4.2')}",
     "tsx": "@declapract{check.minVersion('4.20.6')}",
     "@swc/core": "@declapract{check.minVersion('1.15.3')}",

package/dist/practices/typescript/best-practice/package.json

@@ -1,7 +1,8 @@
 {
   "devDependencies": {
     "typescript": "@declapract{check.minVersion('5.4.5')}",
-    "@tsconfig/node-lts-strictest": "@declapract{check.minVersion('18.12.1')}"
+    "@tsconfig/node20": "@declapract{check.minVersion('20.1.5')}",
+    "@tsconfig/strictest": "@declapract{check.minVersion('2.0.5')}"
   },
   "scripts": {
     "build:clean": "rm dist/ -rf",

package/dist/practices/typescript/best-practice/tsconfig.json

@@ -1,5 +1,8 @@
 {
-  "extends": "@tsconfig/node-lts-strictest/tsconfig.json",
+  "extends": [
+    "@tsconfig/strictest/tsconfig.json",
+    "@tsconfig/node20/tsconfig.json"
+  ],
   "compilerOptions": {
     "importsNotUsedAsValues": "remove",
     "noPropertyAccessFromIndexSignature": false,

package/dist/useCases.yml

@@ -14,7 +14,6 @@ use-cases:
       - node
       - nonpublished-modules
       - package-json-order
-      - prettier
       - tests
       - typescript
       - pnpm
@@ -70,7 +69,6 @@ use-cases:
       - node
       - nonpublished-modules
       - package-json-order
-      - prettier
       - terraform-common
       - provision-github
       - lint

package/package.json

@@ -2,7 +2,7 @@
   "name": "declapract-typescript-ehmpathy",
   "author": "ehmpathy",
   "description": "declapract best practices declarations for typescript",
-  "version": "0.42.5",
+  "version": "0.43.0",
   "license": "MIT",
   "main": "src/index.js",
   "repository": "ehmpathy/declapract-typescript-ehmpathy",

package/dist/practices/lint/best-practice/.declapract.todo.md

@@ -1,5 +0,0 @@
-# todo
-
-replace with biome
-
-its faster and requires less deps

package/dist/practices/prettier/best-practice/package.json.declapract.ts

@@ -1,3 +0,0 @@
-import { FileCheckType } from 'declapract';
-
-export const check = FileCheckType.CONTAINS;