declapract-typescript-ehmpathy 0.49.10 → 0.49.12

package/dist/practices/persist-with-rds/best-practice/src/utils/config/Config.ts.declapract.ts

@@ -1,39 +0,0 @@
-import { FileCheckType, type FileFixFunction } from 'declapract';
-import { UnexpectedCodePathError } from 'helpful-errors';
-
-export const check = FileCheckType.CONTAINS; // practice must contain this
-
-const variantsToReplace = [
-  `
-  database: {
-    service: {
-      host: string;
-      port: number;
-      database: string;
-      schema: string;
-      username: string;
-      password: string;
-    };
-  };
-  `.trim(),
-];
-
-export const fix: FileFixFunction = (contents, context) => {
-  // if no contents yet, can't fix
-  if (!contents) return { contents };
-
-  // otherwise, try and fix with one of the variants we support
-  const desiredContents = variantsToReplace.reduce(
-    (contentsNow, thisVariant) =>
-      contentsNow?.replace(
-        thisVariant,
-        context.declaredFileContents?.trim() ??
-          UnexpectedCodePathError.throw(
-            'expected to have declared best practice but found null',
-            { context },
-          ),
-      ),
-    contents,
-  );
-  return { contents: desiredContents };
-};

package/dist/practices/persist-with-rds/best-practice/src/utils/config/config.schema.ts.declapract.ts

@@ -1,49 +0,0 @@
-import { FileCheckType, type FileFixFunction } from 'declapract';
-
-export const check = FileCheckType.CONTAINS;
-
-const databaseSchema = `  database: z.object({
-    target: z.object({
-      database: z.string(),
-      schema: z.string(),
-    }),
-    role: z.object({
-      cicd: z.object({
-        username: z.string(),
-        password: z.string(),
-      }),
-      crud: z.object({
-        username: z.string(),
-        password: z.string(),
-      }),
-    }),
-    tunnel: z.object({
-      bastion: z.string(),
-      cluster: z.string(),
-      local: z.object({
-        host: z.string(),
-        port: z.number(),
-      }),
-      lambda: z
-        .object({
-          host: z.string(),
-          port: z.number(),
-        })
-        .nullable(),
-    }),
-  }),`;
-
-export const fix: FileFixFunction = (contents) => {
-  if (!contents) return { contents };
-
-  // if database schema already present, return as-is
-  if (contents.includes('database: z.object(')) return { contents };
-
-  // add database schema before the close of the main object
-  const fixed = contents.replace(
-    /(\s*)\}\);(\s*\n\s*export type Config)/,
-    `$1${databaseSchema}\n});$2`,
-  );
-
-  return { contents: fixed };
-};

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

@@ -1,2 +0,0 @@
-// placeholder export to satisfy getDatabaseConnection import; this practice only checks that the file exists
-export const getConfig = 'placeholder' as any;

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

@@ -1,39 +0,0 @@
-import { FileCheckType, type 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.env.ts

@@ -1,46 +0,0 @@
-import { existsSync, readFileSync } from 'node:fs';
-import { join } from 'node:path';
-import util from 'node:util';
-
-import { jest } from '@jest/globals';
-import { keyrack } from 'rhachet/keyrack';
-
-jest.setTimeout(90000); // we're calling downstream apis
-
-// set console.log to not truncate nested objects
-util.inspect.defaultOptions.depth = 5;
-
-/**
- * .what = verify that we're running from a valid project directory; otherwise, fail fast
- * .why = prevent confusion and hard-to-debug errors from running tests in the wrong directory
- */
-if (!existsSync(join(process.cwd(), 'package.json')))
-  throw new Error('no package.json found in cwd. are you @gitroot?');
-
-/**
- * .what = verify that the env has sufficient auth to run the tests if aws is used; otherwise, fail fast
- * .why =
- *   - 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.yml');
-const requiresAwsAuth =
-  existsSync(declapractUsePath) &&
-  readFileSync(declapractUsePath, 'utf8').includes('awsAccountId');
-if (
-  requiresAwsAuth &&
-  !(process.env.AWS_PROFILE || process.env.AWS_ACCESS_KEY_ID)
-)
-  throw new Error(
-    'no aws credentials present. please authenticate with aws to run acceptance tests',
-  );
-
-/**
- * .what = source credentials from keyrack for test env
- * .why =
- *   - auto-inject keys into process.env
- *   - fail fast with helpful error if keyrack locked or keys absent
- */
-const keyrackYmlPath = join(process.cwd(), '.agent/keyrack.yml');
-if (existsSync(keyrackYmlPath))
-  keyrack.source({ env: 'test', owner: 'ehmpath', mode: 'strict' });

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

@@ -1,108 +0,0 @@
-import { execSync } from 'node:child_process';
-import { existsSync, readFileSync } from 'node:fs';
-import { join } from 'node:path';
-import util from 'node:util';
-
-import { jest } from '@jest/globals';
-import { keyrack } from 'rhachet/keyrack';
-
-jest.setTimeout(90000); // since we're calling downstream apis
-
-// set console.log to not truncate nested objects
-util.inspect.defaultOptions.depth = 5;
-
-/**
- * .what = verify that we're running from a valid project directory; otherwise, fail fast
- * .why = prevent confusion and hard-to-debug errors from running tests in the wrong directory
- */
-if (!existsSync(join(process.cwd(), 'package.json')))
-  throw new Error('no package.json found in cwd. are you @gitroot?');
-
-/**
- * sanity check that unit tests are only run the 'test' environment
- *
- * usecases
- * - prevent polluting prod state with test data
- * - prevent executing financially impacting mutations
- */
-if (
-  (process.env.NODE_ENV !== 'test' ||
-    (process.env.CONFIG && process.env.CONFIG !== 'test')) &&
-  process.env.I_KNOW_THE_RISKS !== 'true'
-)
-  throw new Error(`integration.test config must be 'test'`);
-
-/**
- * .what = source aws profile from keyrack if available
- * .why = keyrack manages which profile to use per environment
- */
-const keyrackYmlPath = join(process.cwd(), '.agent/keyrack.yml');
-if (existsSync(keyrackYmlPath) && !process.env.CI)
-  keyrack.source({ env: 'test', owner: 'ehmpath', mode: 'lenient' });
-
-/**
- * .what = export aws credentials from sso profile if aws is required
- * .why = aws sdk v2 doesn't handle sso_session profiles natively
- */
-const declapractUsePath = join(process.cwd(), 'declapract.use.yml');
-const declapractUseContent = existsSync(declapractUsePath)
-  ? readFileSync(declapractUsePath, 'utf8')
-  : '';
-const requiresAwsAuth = declapractUseContent.includes('awsAccountId');
-if (requiresAwsAuth && !process.env.AWS_ACCESS_KEY_ID && !process.env.CI) {
-  const awsSsoProfile = process.env.AWS_PROFILE;
-  if (!awsSsoProfile)
-    throw new Error(
-      'AWS_PROFILE not set. keyrack.source() should have set it.',
-    );
-  try {
-    const credOutput = execSync(
-      `aws configure export-credentials --profile ${awsSsoProfile} --format env`,
-      { encoding: 'utf8', timeout: 10000 },
-    );
-    // parse and set env vars from output like "export AWS_ACCESS_KEY_ID=..."
-    credOutput.split('\n').forEach((line) => {
-      const match = line.match(/^export\s+(\w+)=(.*)$/);
-      if (match) process.env[match[1]!] = match[2]!;
-    });
-  } catch {
-    throw new Error(
-      `failed to export aws credentials from sso profile '${awsSsoProfile}'. run: aws sso login --profile ${awsSsoProfile}`,
-    );
-  }
-}
-
-/**
- * .what = verify that the testdb has been provisioned if a databaseUserName is declared
- * .why =
- *   - prevent time wasted waiting on tests to fail due to missing testdb
- *   - prevent confusing "password authentication failed" errors when testdb isn't running or was provisioned for a different repo
- */
-const requiresTestDb = declapractUseContent.includes('databaseUserName');
-if (requiresTestDb) {
-  const testConfigPath = join(process.cwd(), 'config', 'test.json');
-  if (!existsSync(testConfigPath))
-    throw new Error(
-      'config/test.json not found but serviceUser is declared in declapract.use.yml',
-    );
-  const testConfig = JSON.parse(readFileSync(testConfigPath, 'utf8'));
-  if (
-    !testConfig.database?.tunnel?.local ||
-    !testConfig.database?.role?.crud ||
-    !testConfig.database?.target?.database
-  )
-    throw new Error(
-      'config/test.json database.tunnel.local, database?.role?.crud, or database?.target?.database not found but expected',
-    );
-  try {
-    execSync(
-      `PGPASSWORD="${testConfig.database.role.crud.password}" psql -h ${testConfig.database.tunnel.local.host} -p ${testConfig.database.tunnel.local.port} -U ${testConfig.database.role.crud.username} -d ${testConfig.database.target.database} -c "SELECT 1" > /dev/null 2>&1`,
-      { timeout: 3000 },
-    );
-  } catch (error) {
-    throw new Error(
-      `did you forget to \`npm run start:testdb\`? cant connect to database`,
-      { cause: error },
-    );
-  }
-}

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

@@ -1,35 +0,0 @@
-// eslint-disable-next-line import/no-extraneous-dependencies
-
-import type { FileContentsFunction } from 'declapract';
-import { FileCheckType } from 'declapract';
-
-import { readFile } from '../../../utils/readFile';
-
-/**
- * declare the expected contents
- */
-export const contents: FileContentsFunction = async (context) => {
-  // grab the superset of best practices content
-  const contentsSuperset = await readFile(`${__dirname}/jest.unit.env.ts`);
-
-  // remove things that are irrelevant, based on other practices in use in project
-  let contents = contentsSuperset;
-  if (!context.projectPractices.includes('config'))
-    contents = contents.replace(
-      `// mock that getConfig just returns plaintext test env config in unit tests
-jest.mock('./src/utils/config/getConfig', () => ({
-  getConfig: jest.fn().mockImplementation(() => require('./config/test.json')),
-}));
-
-`,
-      '',
-    );
-
-  // return the narrowed contents
-  return contents;
-};
-
-/**
- * check that they're contained in the file
- */
-export const check: FileCheckType = FileCheckType.CONTAINS;

package/dist/practices/tests-service/defineFunctionNameFromTestFileName.ts

@@ -1,11 +0,0 @@
-import { FileCheckContext } from 'declapract';
-
-export const defineFunctionNameFromTestFileName = ({
-  context,
-}: {
-  context: FileCheckContext;
-}): string =>
-  context.relativeFilePath // same name as the file
-    .split('/')
-    .slice(-1)[0]!
-    .replace('.acceptance.test.ts', ''); // remove the extension from the file

package/dist/practices/typescript/bad-practices/relative-imports/.declapract.readme.md

@@ -1,27 +0,0 @@
-this bad practice detects relative imports that traverse up directories (`../`) and can be replaced with the `@src/` path alias.
-
-why this matters:
-- relative paths are fragile and break when files are moved or reorganized
-- `@src/` alias provides stable, absolute imports from the src root
-- enables easier refactoring and code navigation
-- imports remain correct regardless of file location
-
-what it catches:
-- imports using `../` (e.g., `from '../utils/helper'`)
-- deeply nested relative imports (e.g., `from '../../../domain/objects'`)
-
-what it ignores:
-- same-directory imports (`./`) which are appropriate for local modules
-- files outside `src/` directory
-- imports already using `@src/` alias
-
-the fix automatically rewrites:
-```typescript
-// before
-import { helper } from '../utils/helper';
-import { thing } from '../../shared/thing';
-
-// after
-import { helper } from '@src/utils/helper';
-import { thing } from '@src/shared/thing';
-```

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

@@ -1,15 +0,0 @@
-this bundle defines best practices for tsconfig
-
-namely:
-- build vs test config
-- default name as test config, so that ide's automatically typecheck test files for you
-  - otherwise, they exclude them, and you only find ts errors _after_ you run tsc - not while looking at file
-- strict
-  - strict mode on tsc prevents a _ton_ of errors
-  - without it, `Type | null` -> `Type` -> so you have a bunch of bugs whenever a value could be null but you dont expect it to be / realize it could be
-    - it defeats the point of typechecking, really
-- absolute imports via @src/* path alias
-  - eliminates fragile relative paths (../../..)
-  - imports are stable regardless of file location
-  - easier refactoring and code navigation
-  - uses tsc-alias post-compilation to rewrite paths for node runtime

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

@@ -1,18 +0,0 @@
-import { FileCheckType, type FileContentsFunction } from 'declapract';
-
-import { readFile } from '../../../utils/readFile';
-
-export const contents: FileContentsFunction = async (context) => {
-  // grab the superset of best practices content
-  const contentsSuperset = await readFile(`${__dirname}/package.json`);
-
-  // remove things that are irrelevant, based on other practices in use in project
-  let contents = contentsSuperset;
-  if (!context.projectPractices.includes('artifact'))
-    contents = contents.replace(` && npm run build:artifact`, '');
-
-  // return the narrowed contents
-  return contents;
-};
-
-export const check = FileCheckType.CONTAINS;