declapract-typescript-ehmpathy 0.42.3 → 0.42.5

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

@@ -1,6 +1,6 @@
 {
   "devDependencies": {
-    "simple-artifact-builder": "@declapract{check.minVersion('1.1.13')}"
+    "simple-artifact-builder": "@declapract{check.minVersion('1.1.15')}"
   },
   "scripts": {
     "build:artifact": "npx simple-artifact-builder zip"

package/dist/practices/cicd-service/best-practice/package.json

@@ -1,6 +1,6 @@
 {
   "devDependencies": {
-    "declastruct": "@declapract{check.minVersion('1.3.0')}",
+    "declastruct": "@declapract{check.minVersion('1.4.0')}",
     "declastruct-aws": "@declapract{check.minVersion('1.0.3')}",
     "declastruct-unix-network": "@declapract{check.minVersion('1.0.0')}"
   }

package/dist/practices/config/best-practice/src/utils/config/getConfig.ts

@@ -1,8 +1,9 @@
 // export a default instance of the config object
 import ConfigCache from 'config-with-paramstore';
 
-import { stage } from '../environment';
-import { Config } from './Config';
+import { getEnvironment } from '../environment';
+import { type Config } from './Config';
 
 export const configInstance = new ConfigCache();
-export const getConfig = async (): Promise<Config> => configInstance.get(stage);
+export const getConfig = async (): Promise<Config> =>
+  configInstance.get((await getEnvironment()).config);

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

@@ -0,0 +1,7 @@
+{
+  "dependencies": {
+    "@aws-sdk/client-iam": "@declapract{check.minVersion('3.940.0')}",
+    "with-simple-cache": "@declapract{check.minVersion('0.15.1')}",
+    "simple-in-memory-cache": "@declapract{check.minVersion('0.4.0')}"
+  }
+}

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

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

package/dist/practices/environments/best-practice/src/utils/environment.ts

@@ -1,8 +1,29 @@
-import { createIsOfEnum } from 'type-fns';
+import {
+  IAMClient,
+  ListAccountAliasesCommand,
+  type ListAccountAliasesCommandOutput,
+} from '@aws-sdk/client-iam';
+import { UnexpectedCodePathError } from 'helpful-errors';
+import { createCache } from 'simple-in-memory-cache';
+import { createIsOfEnum, type Literalize } from 'type-fns';
+import { withSimpleCache } from 'with-simple-cache';
 
 import { log } from './logger';
 
-export enum Stage {
+export enum ConfigChoice {
+  PRODUCTION = 'prod',
+  DEVELOPMENT = 'dev',
+  TEST = 'test',
+}
+export const isOfConfigChoice = createIsOfEnum(ConfigChoice);
+
+export enum Access {
+  PRODUCTION = 'prod',
+  DEVELOPMENT = 'dev',
+}
+export const isOfAccess = createIsOfEnum(Access);
+
+export enum Stage { // todo: deprecate stage
   PRODUCTION = 'prod',
   DEVELOPMENT = 'dev',
   TEST = 'test',
@@ -19,7 +40,7 @@ export const isOfStage = createIsOfEnum(Stage);
  */
 const TIMEZONE = process.env.TZ;
 if (TIMEZONE !== 'UTC') {
-  log.warn(
+  log.debug(
     'env.TZ is not set to UTC. this can cause issues. updating this on your behalf',
     { found: TIMEZONE, desire: 'UTC' },
   );
@@ -43,27 +64,98 @@ const inferStageFromNodeEnv = () => {
 /**
  * a method that exposes relevant environmental variables in a standard way
  */
-const getEnvironment = () => {
+export const getStage = (): Stage => {
   const stage = process.env.STAGE ?? inferStageFromNodeEnv(); // figure it out from NODE_ENV if not explicitly defined
   if (!stage) throw new Error('process.env.STAGE must be defined');
   if (!isOfStage(stage)) throw new Error(`invalid stage defined '${stage}'`);
-  return { stage };
+  return stage;
 };
 
-// export stage immediately, since it does not change; // todo: replace this with env.access
-export const { stage } = getEnvironment();
+/**
+ * .what = infer access (prod/dev) from curernt credentials
+ *
+ * .why?
+ * - allows detection of the access grain we are currently authenticated into, if authenticated
+ * - account aliases typically contain the environment (e.g., 'ahbode-dev', 'ahbode-prod')
+ */
+export const inferAccess = withSimpleCache(
+  async (): Promise<Access | null> => {
+    // skip aws api calls if no credentials are configured
+    if (!process.env.AWS_PROFILE && !process.env.AWS_ACCESS_KEY_ID) return null;
+
+    // grab the alias of the current account
+    const iam = new IAMClient({});
+    const response: ListAccountAliasesCommandOutput = await iam.send(
+      new ListAccountAliasesCommand({}),
+    );
+
+    // infer access from alias
+    const alias = response.AccountAliases?.[0];
+    if (alias?.includes('prod')) return Access.PRODUCTION;
+    if (alias?.includes('dev')) return Access.DEVELOPMENT;
+    throw new Error(`Could not infer access from account alias '${alias}'`);
+  },
+  { cache: createCache() },
+);
 
-// export service client stage
-export const serviceClientStage =
-  stage === Stage.PRODUCTION ? Stage.PRODUCTION : Stage.DEVELOPMENT; // i.e., if its prod, hit prod. otherwise, dev
+/**
+ * infer stage from access (prod/dev)
+ *
+ * logic:
+ * - if NODE_ENV === 'test', return test (test environment always uses test config)
+ * - otherwise, defer to access from AWS credentials
+ */
+const inferConfigChoice = async (): Promise<ConfigChoice> => {
+  // grab some facts
+  const access = await inferAccess();
+  const envarNode = process.env.NODE_ENV;
+  const envarConfig = process.env.CONFIG ?? process.env.STAGE; // fallback to stage as alias to config choice
+
+  // if access is against prod, then must use prod config; no exceptions
+  if (access === Access.PRODUCTION) return ConfigChoice.PRODUCTION;
+
+  // if access is against prep and asked for dev, then use dev config
+  if (access === Access.DEVELOPMENT && envarConfig === 'dev')
+    return ConfigChoice.DEVELOPMENT;
+
+  // if access is against prep and asked for test, then use test config
+  if (access === Access.DEVELOPMENT && envarNode === 'test')
+    return ConfigChoice.TEST;
+
+  // if access is against prep and not asked for test, then must use dev config
+  if (access === Access.DEVELOPMENT) return ConfigChoice.DEVELOPMENT;
+
+  // otherwise, unsupported
+  throw new UnexpectedCodePathError(
+    'Could not infer config choice: NODE_ENV is not test and no valid access could be determined',
+    { access, envarNode, envarConfig },
+  );
+};
 
 // export the v3 environmental variables
-export const environment = {
-  access: stage,
+export interface Environment {
+  /**
+   * .what = the choice of config to execute against
+   */
+  config: Literalize<ConfigChoice>;
+
+  /**
+   * .what = the resources accessible from this environment, if any
+   */
+  access: Literalize<Access> | null;
+
+  /**
+   * .what = the server that hosts this environment
+   */
+  server: 'CICD' | 'AWS:LAMBDA' | 'LOCAL';
+}
+export const getEnvironment = async (): Promise<Environment> => ({
+  config: await inferConfigChoice(),
+  access: await inferAccess(),
   server: (() => {
     if (process.env.CI) return 'CICD' as const;
     if (process.env.LAMBDA_TASK_ROOT) return 'AWS:LAMBDA' as const;
     return 'LOCAL' as const; // default to local
   })(),
   // region: // todo
-};
+});

package/dist/practices/git/best-practice/.gitignore.declapract.ts

@@ -12,6 +12,7 @@ const expectedIgnores = [
   '.terraform.lock',
   '.yalc',
   '.temp',
+  '.vscode',
   'coverage',
   'dist',
   'node_modules',

package/dist/practices/lint/bad-practices/depcheck-denylisted-ignores/.declapract.readme.md

@@ -0,0 +1,8 @@
+These packages should not be ignored in depcheck - they are either deprecated or have better alternatives:
+
+- date-fns: use luxon instead
+- procedure-fns: deprecated
+- ts-node: use tsx instead
+- ts-jest: use @swc/jest instead
+- core-js: no longer needed with modern node
+- babel-jest: use @swc/jest instead

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

@@ -0,0 +1,59 @@
+import { FileCheckFunction, FileFixFunction } from 'declapract';
+import expect from 'expect';
+import yaml from 'yaml';
+
+const denylist = [
+  'date-fns',
+  'procedure-fns',
+  'ts-node',
+  'ts-jest',
+  'core-js',
+  'babel-jest',
+];
+
+export const check: FileCheckFunction = (contents) => {
+  if (!contents) throw new Error('no file found'); // no file = not bad practice
+
+  const parsed = yaml.parse(contents) as { ignores?: string[] };
+  const currentIgnores = parsed?.ignores ?? [];
+
+  // Find denylisted ignores that are present
+  const denylistedPresent = currentIgnores.filter((item) =>
+    denylist.includes(item),
+  );
+
+  // Bad practice: throw if no denylisted items found (all is fine), return if denylisted items exist
+  if (denylistedPresent.length === 0) {
+    throw new Error('no denylisted packages found in ignores');
+  }
+  // Return (don't throw) = bad practice detected
+};
+
+export const fix: FileFixFunction = (contents) => {
+  if (!contents) return { contents };
+
+  // Parse using parseDocument to preserve comments
+  const doc = yaml.parseDocument(contents);
+  const parsed = doc.toJSON() as { ignores?: string[] };
+  const currentIgnores = parsed?.ignores ?? [];
+
+  // Find denylisted ignores that are present
+  const denylistedPresent = currentIgnores.filter((item) =>
+    denylist.includes(item),
+  );
+
+  if (denylistedPresent.length === 0) return { contents };
+
+  // Remove denylisted ignores from the document
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  const ignoresNode = doc.get('ignores') as any;
+  if (ignoresNode?.items) {
+    // Filter out denylisted items
+    ignoresNode.items = ignoresNode.items.filter(
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      (item: any) => !denylist.includes(item.value ?? item),
+    );
+  }
+
+  return { contents: doc.toString() };
+};

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

@@ -1,15 +1,11 @@
 ignores:
-  - depcheck
+  - rhachet
   - declapract
   - declapract-typescript-ehmpathy
   - '@commitlint/config-conventional'
   - '@trivago/prettier-plugin-sort-imports'
   - '@tsconfig/node-lts-strictest'
-  - babel-jest
-  - core-js
-  - ts-jest
   - tsx
   - husky
-  - if-env
-  - test-fns
-  - helpful-errors
+  - '@swc/core'
+  - '@swc/jest'

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

@@ -1,4 +1,41 @@
 // eslint-disable-next-line import/no-extraneous-dependencies
-import { FileCheckType } from 'declapract';
+import { FileCheckType, FileFixFunction } from 'declapract';
+// eslint-disable-next-line import/no-extraneous-dependencies
+import yaml from 'yaml';
 
 export const check = FileCheckType.CONTAINS;
+
+export const fix: FileFixFunction = (contents, context) => {
+  if (!contents) return { contents: context.declaredFileContents };
+
+  const declaredContents = context.declaredFileContents ?? '';
+
+  // Parse both files as YAML (using parseDocument to preserve comments)
+  const currentDoc = yaml.parseDocument(contents);
+  const declaredParsed = yaml.parse(declaredContents) as { ignores?: string[] };
+
+  const currentIgnores =
+    (currentDoc.toJSON() as { ignores?: string[] })?.ignores ?? [];
+  const declaredIgnores = declaredParsed?.ignores ?? [];
+
+  // Find missing ignores
+  const missingIgnores = declaredIgnores.filter(
+    (item) => !currentIgnores.includes(item),
+  );
+
+  if (missingIgnores.length === 0) return { contents };
+
+  // Add missing ignores to the document (preserves comments)
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  let ignoresNode = currentDoc.get('ignores') as any;
+  if (!ignoresNode) {
+    currentDoc.set('ignores', []);
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    ignoresNode = currentDoc.get('ignores') as any;
+  }
+  for (const ignore of missingIgnores) {
+    ignoresNode.add(ignore);
+  }
+
+  return { contents: currentDoc.toString() };
+};

package/dist/practices/persist-with-rds/bad-practices/old-integration-test-db-dir/.declapract.readme.md

@@ -1 +1 @@
-we switched from `provision/docker/integration_test_db` to `provision/docker/integration-test-db`
+we switched from `provision/docker/integration_test_db` to `provision/docker/testdb`

package/dist/practices/persist-with-rds/bad-practices/old-integration-test-db-dir/provision/docker/integration_test_db/<star><star>/<star>.declapract.ts

@@ -1,3 +1,15 @@
-import { FileCheckType } from 'declapract';
+import { FileCheckType, FileFixFunction } from 'declapract';
 
 export const check = FileCheckType.EXISTS; // if a file exists with this path pattern, then it's bad practice
+
+export const fix: FileFixFunction = async (contents, { relativeFilePath }) => {
+  // Move from integration_test_db to testdb
+  const newPath = relativeFilePath.replace(
+    'provision/docker/integration_test_db',
+    'provision/docker/testdb',
+  );
+  return {
+    contents,
+    relativeFilePath: newPath,
+  };
+};

package/dist/practices/persist-with-rds/bad-practices/old-integration-test-db-hyphen-dir/.declapract.readme.md

@@ -0,0 +1 @@
+we switched from `provision/docker/integration-test-db` to `provision/docker/testdb`

package/dist/practices/persist-with-rds/bad-practices/old-integration-test-db-hyphen-dir/provision/docker/integration-test-db/<star><star>/<star>.declapract.ts

@@ -0,0 +1,15 @@
+import { FileCheckType, FileFixFunction } from 'declapract';
+
+export const check = FileCheckType.EXISTS; // if a file exists with this path pattern, then it's bad practice
+
+export const fix: FileFixFunction = async (contents, { relativeFilePath }) => {
+  // Move from integration-test-db to testdb
+  const newPath = relativeFilePath.replace(
+    'provision/docker/integration-test-db',
+    'provision/docker/testdb',
+  );
+  return {
+    contents,
+    relativeFilePath: newPath,
+  };
+};

package/dist/practices/persist-with-rds/bad-practices/old-integration-test-db-paths/.declapract.readme.md

@@ -0,0 +1 @@
+we switched from `provision/docker/integration-test-db` to `provision/docker/testdb` - this detects old paths in package.json scripts

package/dist/practices/persist-with-rds/bad-practices/old-integration-test-db-paths/package.json

@@ -0,0 +1,8 @@
+{
+  "scripts": {
+    "provision:testdb:docker:prepare": "@declapract{check.contains('integration-test-db')}",
+    "provision:testdb:docker:up": "@declapract{check.contains('integration-test-db')}",
+    "provision:testdb:docker:await": "@declapract{check.contains('integration-test-db')}",
+    "provision:testdb:docker:down": "@declapract{check.contains('integration-test-db')}"
+  }
+}

package/dist/practices/persist-with-rds/bad-practices/old-integration-test-db-paths/package.json.declapract.ts

@@ -0,0 +1,10 @@
+import { FileCheckType, FileFixFunction } from 'declapract';
+
+export const check = FileCheckType.CONTAINS;
+
+export const fix: FileFixFunction = (contents) => {
+  if (!contents) return { contents }; // do nothing if no contents
+  // Replace integration-test-db with testdb in all paths
+  const fixed = contents.replace(/integration-test-db/g, 'testdb');
+  return { contents: fixed };
+};

package/dist/practices/persist-with-rds/best-practice/package.json

@@ -18,11 +18,11 @@
     "provision:schema:plan": "npx sql-schema-control plan -c provision/schema/control.yml",
     "provision:schema:apply": "npx sql-schema-control apply -c provision/schema/control.yml",
     "provision:schema:sync": "npx sql-schema-control sync -c provision/schema/control.yml",
-    "provision:testdb:docker:clear": "docker rm -f $(docker ps -a -f 'publish=7821' -q) 2>/dev/null || true && echo 'ensured port is available 👍'",
-    "provision:testdb:docker:prepare": "cp provision/schema/sql/init/.extensions.sql provision/docker/integration-test-db/init/extensions.sql && cp provision/schema/sql/init/.schema.sql provision/docker/integration-test-db/init/schema.sql && cp provision/schema/sql/init/.user.cicd.sql provision/docker/integration-test-db/init/user.cicd.sql",
-    "provision:testdb:docker:up": "docker compose -f ./provision/docker/integration-test-db/docker-compose.yml up -d --force-recreate --build --renew-anon-volumes",
-    "provision:testdb:docker:await": "docker compose -f ./provision/docker/integration-test-db/docker-compose.yml exec -T postgres /root/wait-for-postgres.sh",
-    "provision:testdb:docker:down": "docker compose -f ./provision/docker/integration-test-db/docker-compose.yml down",
+    "provision:testdb:docker:clear": "for port in $(docker compose -f ./provision/docker/testdb/docker-compose.yml config --format json | jq -r '.services[].ports[]?.published'); do docker rm -f $(docker ps -a -f \"publish=$port\" -q) 2>/dev/null || true; done && echo 'ensured ports are available 👍'",
+    "provision:testdb:docker:prepare": "cp provision/schema/sql/init/.extensions.sql provision/docker/testdb/init/extensions.sql && cp provision/schema/sql/init/.schema.sql provision/docker/testdb/init/schema.sql && cp provision/schema/sql/init/.user.cicd.sql provision/docker/testdb/init/user.cicd.sql",
+    "provision:testdb:docker:up": "docker compose -f ./provision/docker/testdb/docker-compose.yml up -d --force-recreate --build --renew-anon-volumes",
+    "provision:testdb:docker:await": "docker compose -f ./provision/docker/testdb/docker-compose.yml exec -T postgres /root/wait-for-postgres.sh",
+    "provision:testdb:docker:down": "docker compose -f ./provision/docker/testdb/docker-compose.yml down",
     "provision:testdb": "npm run provision:testdb:docker:clear && npm run provision:testdb:docker:prepare && npm run provision:testdb:docker:up && npm run provision:testdb:docker:await && npm run provision:schema:plan && npm run provision:schema:apply && npm run provision:schema:plan",
     "start:testdb": "npm run provision:testdb",
     "start:livedb:dev": "echo 'will ping the database until assured its not asleep' && STAGE=dev .agent/repo=.this/skills/use.rds.capacity.sh"

package/dist/practices/persist-with-rds/best-practice/provision/docker/{integration-test-db → testdb}/build-image.dockerfile

@@ -1,4 +1,4 @@
-FROM postgres:10.7
+FROM postgres:13.20
 
 COPY init/ /docker-entrypoint-initdb.d/
 

package/dist/practices/persist-with-rds/best-practice/provision/docker/{integration-test-db → testdb}/docker-compose.yml

@@ -11,3 +11,8 @@ services:
     environment:
       POSTGRES_PASSWORD: a-secure-password # default user is `postgres`
       POSTGRES_DB: @declapract{variable.databaseName} # creates the database for us automatically
+    healthcheck:
+      test: ['CMD-SHELL', 'pg_isready -U postgres -d homeservicesdb']
+      interval: 5s
+      timeout: 5s
+      retries: 5

package/dist/practices/persist-with-rds/best-practice/provision/schema/deploy.database.sh

@@ -13,7 +13,7 @@
 ##
 ## usage example:
 ## ```sh
-## ./provision/schema/deploy.database.sh dev $(op get item @declapract{variable.organizationName}db.dev.postgres | jq -r .details.password)
+## ./provision/schema/deploy.database.sh dev $(op item get ahbodedb.dev.postgres --fields label=password --format json | jq -r .value)
 ## ```
 #####################################################
 

package/dist/practices/persist-with-rds/best-practice/src/utils/database/getDatabaseConnection.ts

@@ -2,7 +2,7 @@ import { HelpfulError, UnexpectedCodePathError } from 'helpful-errors';
 import pg, { Client, QueryResult, QueryResultRow } from 'pg';
 
 import { getConfig } from '../config/getConfig';
-import { environment } from '../environment';
+import { getEnvironment } from '../environment';
 
 // https://github.com/brianc/node-postgres/pull/353#issuecomment-283709264
 pg.types.setTypeParser(20, (value) => parseInt(value, 10)); // cast bigints to numbers; by default, pg returns bigints as strings, since max val of bigint is bigger than max safe value in js
@@ -40,6 +40,7 @@ values:
 }
 
 export const getDatabaseConnection = async (): Promise<DatabaseConnection> => {
+  const environment = await getEnvironment();
   const config = await getConfig();
   const target = config.database.target;
   const role = config.database.role.crud;

package/dist/practices/pnpm/best-practice/.agent/repo=.this/skills/use.npm.alias.sh

@@ -7,7 +7,8 @@
 # What it does:
 #   1. Creates an alias 'npm.slow' pointing to the original npm binary
 #   2. Creates an alias 'npm' that redirects to pnpm
-#   3. Persists aliases to ~/.bash_aliases (sourced by ~/.bashrc)
+#   3. Sets up pnpm tab completion (works for both pnpm and npm alias)
+#   4. Everything goes in ~/.bash_aliases (works in both bash and zsh)
 #
 # When to use:
 #   - After setting up a new development environment
@@ -19,15 +20,15 @@
 set -euo pipefail
 
 BASH_ALIASES="${HOME}/.bash_aliases"
-
-# ensure ~/.bash_aliases exists
 touch "$BASH_ALIASES"
 
 # findsert npm.slow (only add if not already defined)
 if ! grep -q "^alias npm.slow=" "$BASH_ALIASES" 2>/dev/null; then
   NPM_PATH=$(which npm)
   echo "alias npm.slow=\"$NPM_PATH\"" >> "$BASH_ALIASES"
-  echo "Added: alias npm.slow=\"$NPM_PATH\""
+  echo "👍 findsert: alias npm.slow=\"$NPM_PATH\""
+else
+  echo "👍 findsert: npm.slow alias already exists"
 fi
 
 # upsert npm => pnpm
@@ -36,7 +37,7 @@ if grep -q "^alias npm=" "$BASH_ALIASES" 2>/dev/null; then
 else
   echo 'alias npm="pnpm"' >> "$BASH_ALIASES"
 fi
-echo "Added: alias npm=\"pnpm\""
+echo "👍 upsert: alias npm=\"pnpm\""
 
 # report
 echo ""

package/dist/practices/prettier/best-practice/.prettierignore

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

package/dist/practices/prettier/best-practice/prettier.config.js

@@ -4,6 +4,7 @@ module.exports = {
   trailingComma: 'all',
   tabWidth: 2,
   singleQuote: true,
+  plugins: ['@trivago/prettier-plugin-sort-imports'],
   importOrder: ['^[./]'],
   importOrderSeparation: true,
 };

package/dist/practices/provision-github/best-practice/package.json

@@ -1,6 +1,6 @@
 {
   "devDependencies": {
-    "declastruct": "@declapract{check.minVersion('1.3.0')}",
+    "declastruct": "@declapract{check.minVersion('1.4.0')}",
     "declastruct-github": "@declapract{check.minVersion('1.0.3')}"
   }
 }

package/dist/practices/tests/bad-practices/deprecated-test-deps/.declapract.readme.md

@@ -0,0 +1,7 @@
+These test dependencies are deprecated and should be removed:
+
+- babel-jest: use @swc/jest instead (faster)
+- @babel/core: no longer needed with @swc/jest
+- @babel/preset-env: no longer needed with @swc/jest
+- core-js: no longer needed with modern node
+- ts-jest: use @swc/jest instead (faster)

package/dist/practices/tests/bad-practices/deprecated-test-deps/package.json

@@ -0,0 +1,9 @@
+{
+  "devDependencies": {
+    "babel-jest": "@declapract{check.minVersion('0.0.0')}",
+    "@babel/core": "@declapract{check.minVersion('0.0.0')}",
+    "@babel/preset-env": "@declapract{check.minVersion('0.0.0')}",
+    "core-js": "@declapract{check.minVersion('0.0.0')}",
+    "ts-jest": "@declapract{check.minVersion('0.0.0')}"
+  }
+}

package/dist/practices/tests/bad-practices/deprecated-test-deps/package.json.declapract.ts

@@ -0,0 +1,39 @@
+import { FileCheckType, FileFixFunction } from 'declapract';
+
+export const check = FileCheckType.CONTAINS;
+
+const deprecatedDeps = [
+  'babel-jest',
+  '@babel/core',
+  '@babel/preset-env',
+  'core-js',
+  'ts-jest',
+];
+
+export const fix: FileFixFunction = (contents) => {
+  if (!contents) return { contents }; // do nothing if no contents
+  const packageJSON = JSON.parse(contents);
+
+  // Remove deprecated deps from devDependencies
+  const updatedDevDeps = { ...packageJSON.devDependencies };
+  for (const dep of deprecatedDeps) {
+    delete updatedDevDeps[dep];
+  }
+
+  // Remove deprecated deps from dependencies (in case they're there)
+  const updatedDeps = { ...packageJSON.dependencies };
+  for (const dep of deprecatedDeps) {
+    delete updatedDeps[dep];
+  }
+
+  const updatedPackageJSON = {
+    ...packageJSON,
+    dependencies: Object.keys(updatedDeps).length > 0 ? updatedDeps : undefined,
+    devDependencies:
+      Object.keys(updatedDevDeps).length > 0 ? updatedDevDeps : undefined,
+  };
+
+  return {
+    contents: JSON.stringify(updatedPackageJSON, null, 2),
+  };
+};

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

@@ -12,15 +12,13 @@ const config: Config = {
   testEnvironment: 'node',
   moduleFileExtensions: ['js', 'ts'],
   transform: {
-    '^.+\\.tsx?$': 'ts-jest', // https://kulshekhar.github.io/ts-jest/docs/getting-started/presets
-    '^.+\\.(js|jsx|mjs)$': 'babel-jest', // transform esm modules with babel
+    '^.+\\.(t|j)sx?$': '@swc/jest',
   },
   transformIgnorePatterns: [
     // here's an example of how to ignore esm module transformation, when needed
     // 'node_modules/(?!(@octokit|universal-user-agent|before-after-hook)/)',
   ],
   testMatch: ['**/*.acceptance.test.ts'],
-  setupFiles: ['core-js'],
   setupFilesAfterEnv: ['./jest.acceptance.env.ts'],
 
   // use 50% of threads to leave headroom for other processes

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

@@ -21,7 +21,7 @@ if (!existsSync(join(process.cwd(), 'package.json')))
  *   - prevent time wasted waiting on tests to fail due to lack of credentials
  *   - prevent time wasted debugging tests which are failing due to hard-to-read missed credential errors
  */
-const declapractUsePath = join(process.cwd(), 'declapract.use.ts');
+const declapractUsePath = join(process.cwd(), 'declapract.use.yml');
 const requiresAwsAuth =
   existsSync(declapractUsePath) &&
   readFileSync(declapractUsePath, 'utf8').includes('awsAccountId');

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

@@ -12,15 +12,13 @@ const config: Config = {
   testEnvironment: 'node',
   moduleFileExtensions: ['js', 'ts'],
   transform: {
-    '^.+\\.tsx?$': 'ts-jest', // https://kulshekhar.github.io/ts-jest/docs/getting-started/presets
-    '^.+\\.(js|jsx|mjs)$': 'babel-jest', // transform esm modules with babel
+    '^.+\\.(t|j)sx?$': '@swc/jest',
   },
   transformIgnorePatterns: [
     // here's an example of how to ignore esm module transformation, when needed
     // 'node_modules/(?!(@octokit|universal-user-agent|before-after-hook)/)',
   ],
   testMatch: ['**/*.integration.test.ts'],
-  setupFiles: ['core-js'],
   setupFilesAfterEnv: ['./jest.integration.env.ts'],
 
   // use 50% of threads to leave headroom for other processes

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

@@ -23,7 +23,8 @@ if (!existsSync(join(process.cwd(), 'package.json')))
  * - prevent executing financially impacting mutations
  */
 if (
-  (process.env.NODE_ENV !== 'test' || process.env.STAGE) &&
+  (process.env.NODE_ENV !== 'test' ||
+    (process.env.STAGE && process.env.STAGE !== 'test')) &&
   process.env.I_KNOW_WHAT_IM_DOING !== 'true'
 )
   throw new Error(`integration.test is not targeting stage 'test'`);
@@ -34,7 +35,7 @@ if (
  *   - prevent time wasted waiting on tests to fail due to lack of credentials
  *   - prevent time wasted debugging tests which are failing due to hard-to-read missed credential errors
  */
-const declapractUsePath = join(process.cwd(), 'declapract.use.ts');
+const declapractUsePath = join(process.cwd(), 'declapract.use.yml');
 const requiresAwsAuth =
   existsSync(declapractUsePath) &&
   readFileSync(declapractUsePath, 'utf8').includes('awsAccountId');

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

@@ -12,8 +12,7 @@ const config: Config = {
   testEnvironment: 'node',
   moduleFileExtensions: ['js', 'ts'],
   transform: {
-    '^.+\\.tsx?$': 'ts-jest', // https://kulshekhar.github.io/ts-jest/docs/getting-started/presets
-    '^.+\\.(js|jsx|mjs)$': 'babel-jest', // transform esm modules with babel
+    '^.+\\.(t|j)sx?$': '@swc/jest',
   },
   transformIgnorePatterns: [
     // here's an example of how to ignore esm module transformation, when needed
@@ -25,7 +24,6 @@ const config: Config = {
     '!**/*.acceptance.test.ts',
     '!**/*.integration.test.ts',
   ],
-  setupFiles: ['core-js'],
   setupFilesAfterEnv: ['./jest.unit.env.ts'],
 
   // use 50% of threads to leave headroom for other processes

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

@@ -3,12 +3,9 @@
     "@types/jest": "@declapract{check.minVersion('29.2.4')}",
     "jest": "@declapract{check.minVersion('29.3.1')}",
     "test-fns": "@declapract{check.minVersion('1.4.2')}",
-    "ts-jest": "@declapract{check.minVersion('29.4.5')}",
     "tsx": "@declapract{check.minVersion('4.20.6')}",
-    "core-js": "@declapract{check.minVersion('3.26.1')}",
-    "@babel/core": "@declapract{check.minVersion('7.28.5')}",
-    "@babel/preset-env": "@declapract{check.minVersion('7.28.5')}",
-    "babel-jest": "@declapract{check.minVersion('30.2.0')}"
+    "@swc/core": "@declapract{check.minVersion('1.15.3')}",
+    "@swc/jest": "@declapract{check.minVersion('0.2.39')}"
   },
   "scripts": {
     "test:unit": "jest -c ./jest.unit.config.ts --forceExit --verbose --passWithNoTests $([ -z $THOROUGH ] && echo '--changedSince=main')",

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

@@ -7,6 +7,6 @@
     "build:clean": "rm dist/ -rf",
     "build:compile": "tsc -p ./tsconfig.build.json",
     "build": "npm run build:clean && npm run build:compile && npm run build:artifact",
-    "test:types": "tsc -p ./tsconfig.build.json --noEmit"
+    "test:types": "tsc -p ./tsconfig.json --noEmit"
   }
 }

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

@@ -1,7 +1,8 @@
 {
   "extends": "./tsconfig.json",
   "compilerOptions": {
-    "rootDir": "src"
+    "rootDir": "src",
+    "incremental": false
   },
   "include": [
     "src/**/*.ts",

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

@@ -11,6 +11,7 @@
     "sourceMap": true,
     "outDir": "dist",
     "target": "es2020",
+    "incremental": true
   },
   "include": [
     "**/*.ts"

package/package.json

@@ -2,7 +2,7 @@
   "name": "declapract-typescript-ehmpathy",
   "author": "ehmpathy",
   "description": "declapract best practices declarations for typescript",
-  "version": "0.42.3",
+  "version": "0.42.5",
   "license": "MIT",
   "main": "src/index.js",
   "repository": "ehmpathy/declapract-typescript-ehmpathy",
@@ -46,7 +46,8 @@
     "expect": "29.4.2",
     "flat": "5.0.2",
     "helpful-errors": "1.5.3",
-    "simple-log-methods": "0.5.0"
+    "simple-log-methods": "0.5.0",
+    "yaml": "1.10.2"
   },
   "peerDependencies": {
     "declapract": ">=0.12.1"