declapract-typescript-ehmpathy 0.23.0 → 0.23.2

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

@@ -0,0 +1,6 @@
+{
+  "scripts": {
+    "fix:format:terraform": "echo 'terraform not used'",
+    "test:format:terraform": "echo 'terraform not used'"
+  }
+}

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

@@ -0,0 +1,4 @@
+import { FileCheckType } from 'declapract';
+
+// TODO: move this check out into the function that defines `fix:format`, and have it check whether it should include terraform instead
+export const check = FileCheckType.CONTAINS;

package/dist/practices/config/bad-practices/divergent-config-shapes/config/dev.json.declapract.ts

@@ -1,10 +1,7 @@
 import { FileCheckFunction } from 'declapract';
 import flatten from 'flat';
-import fs from 'fs';
-import util from 'util';
 
-export const readFile = async (filePath: string) =>
-  util.promisify(fs.readFile)(filePath, 'utf-8');
+import { readFile } from '../../../../../utils/readFile';
 
 export const check: FileCheckFunction = async (contents, context) => {
   if (!contents) throw new Error('its fine'); // ... yeah, i know, todo: eliminate this weird "throw an error if its fine" pattern

package/dist/practices/config/bad-practices/divergent-config-shapes/config/prod.json.declapract.ts

@@ -1,10 +1,7 @@
 import { FileCheckFunction } from 'declapract';
 import flatten from 'flat';
-import fs from 'fs';
-import util from 'util';
 
-export const readFile = async (filePath: string) =>
-  util.promisify(fs.readFile)(filePath, 'utf-8');
+import { readFile } from '../../../../../utils/readFile';
 
 export const check: FileCheckFunction = async (contents, context) => {
   if (!contents) throw new Error('its fine'); // ... yeah, i know, todo: eliminate this weird "throw an error if its fine" pattern

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

@@ -1,3 +1,32 @@
-import { FileCheckType } from 'declapract';
+import { FileCheckType, FileContentsFunction } from 'declapract/dist/domain';
+import { isPresent } from 'type-fns';
 
-export const check = FileCheckType.CONTAINS;
+/**
+ * declare the expected contents
+ */
+export const contents: FileContentsFunction = (context) => {
+  const formatters = [
+    'prettier',
+    context.projectPractices.includes('terraform') ? 'terraform' : null, // only include the terraform formatter if terraform practice is used
+  ].filter(isPresent);
+
+  return JSON.stringify(
+    {
+      scripts: {
+        'fix:format': formatters
+          .map((formatter) => `npm run fix:format:${formatter}`)
+          .join(' && '),
+        'test:format': formatters
+          .map((formatter) => `npm run test:format:${formatter}`)
+          .join(' && '),
+      },
+    },
+    null,
+    2,
+  );
+};
+
+/**
+ * check that they're contained in the file
+ */
+export const check: FileCheckType = FileCheckType.CONTAINS;

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

@@ -0,0 +1,33 @@
+// eslint-disable-next-line import/no-extraneous-dependencies
+import { FileCheckType } from 'declapract';
+import { FileContentsFunction } from 'declapract/dist/domain';
+
+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(
+      `
+jest.mock('./src/utils/config/getConfig', () => ({
+  getConfig: jest.fn().mockImplementation(() => require('./config/test.json')), // mock that getConfig just returns plaintext test env config in unit tests
+}));
+`,
+      '',
+    );
+
+  // return the narrowed contents
+  return contents;
+};
+
+/**
+ * check that they're contained in the file
+ */
+export const check: FileCheckType = FileCheckType.CONTAINS;

package/dist/utils/readFile.ts

@@ -0,0 +1,5 @@
+import fs from 'fs';
+import util from 'util';
+
+export const readFile = async (filePath: string) =>
+  util.promisify(fs.readFile)(filePath, 'utf-8');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "declapract-typescript-ehmpathy",
-  "version": "0.23.0",
+  "version": "0.23.2",
   "description": "declapract best practices declarations for typescript",
   "main": "src/index.js",
   "repository": "ehmpathy/declapract-typescript-ehmpathy",
@@ -40,7 +40,7 @@
     "uuid": "3.4.0"
   },
   "peerDependencies": {
-    "declapract": "~0.10.10"
+    "declapract": "~0.11.2"
   },
   "devDependencies": {
     "@commitlint/cli": "13.1.0",

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

@@ -1,6 +0,0 @@
-{
-  "scripts": {
-    "fix:format": "npm run fix:format:prettier && npm run fix:format:terraform",
-    "test:format": "npm run test:format:prettier && npm run test:format:terraform"
-  }
-}