declapract-typescript-ehmpathy 0.22.8 → 0.23.2

package/dist/practices/{cicd-integrate → cicd-common}/best-practice/.github/workflows/.test.yml

@@ -6,17 +6,17 @@ on:
       aws-region:
         type: string
         description: the aws region within which we should run the tests
-        required: true
+        required: false
       aws-account-id:
         type: string
         description: the id of the account the credentials are expected to access
-        required: true
+        required: false
     secrets:
       aws-access-key-id:
-        required: true
+        required: false
         description: required credentials to authenticate with aws the aws account against which to run the tests
       aws-secret-access-key:
-        required: true
+        required: false
         description: required credentials to authenticate with aws the aws account against which to run the tests
 
 jobs:
@@ -174,14 +174,16 @@ jobs:
           key: ${{ runner.os }}-node-${{ github.sha }}
 
       - name: configure aws credentials
+        if: "${{ inputs.aws-account-id != '' }}"
         uses: aws-actions/configure-aws-credentials@v1
         id: credentials
         with:
           aws-access-key-id: ${{ secrets.aws-access-key-id }}
           aws-secret-access-key: ${{ secrets.aws-secret-access-key }}
-          aws-region: us-east-1
+          aws-region: ${{ inputs.aws-region }}
 
       - name: confirm aws credentials
+        if: "${{ inputs.aws-account-id != '' }}"
         run: |
           [[ ${{steps.credentials.outputs.aws-account-id}} != ${{ inputs.aws-account-id }} ]] \
             && echo 'wrong aws account' && exit 1 \
@@ -213,14 +215,16 @@ jobs:
           key: ${{ runner.os }}-node-${{ github.sha }}
 
       - name: configure aws credentials
+        if: "${{ inputs.aws-account-id != '' }}"
         uses: aws-actions/configure-aws-credentials@v1
         id: credentials
         with:
           aws-access-key-id: ${{ secrets.aws-access-key-id }}
           aws-secret-access-key: ${{ secrets.aws-secret-access-key }}
-          aws-region: us-east-1
+          aws-region: ${{ inputs.aws-region }}
 
       - name: confirm aws credentials
+        if: "${{ inputs.aws-account-id != '' }}"
         run: |
           [[ ${{steps.credentials.outputs.aws-account-id}} != ${{ inputs.aws-account-id }} ]] \
             && echo 'wrong aws account' && exit 1 \

package/dist/practices/{cicd-deploy-package → cicd-package}/best-practice/.github/workflows/.publish-npm.yml

@@ -12,17 +12,12 @@ jobs:
     runs-on: ubuntu-20.04
     steps:
       - name: checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
-      - name: read nvmrc
-        id: nvmrc
-        run: echo ::set-output name=NODE_VERSION::$(cat .nvmrc)
-
-      - name: setup node
-        uses: actions/setup-node@v2
+      - name: set node version
+        uses: actions/setup-node@v3
         with:
-          node-version: ${{ steps.nvmrc.outputs.NODE_VERSION }}
-          registry-url: 'https://registry.npmjs.org'
+          node-version-file: '.nvmrc'
           cache: 'npm'
 
       - name: install

package/dist/practices/cicd-package/best-practice/.github/workflows/publish.yml

@@ -0,0 +1,15 @@
+name: publish
+
+on:
+  push:
+    tags:
+      - v*
+
+jobs:
+  test:
+    uses: ./.github/workflows/.test.yml
+
+  publish:
+    uses: ./.github/workflows/.publish-npm.yml
+    secrets:
+      npm-auth-token: ${{ secrets.NPM_TOKEN }}

package/dist/practices/cicd-package/best-practice/.github/workflows/test.yml

@@ -0,0 +1,13 @@
+name: test
+
+on:
+  workflow_call:
+  push:
+    branches-ignore:
+      - 'main' # exclude main branch, since deploy workflow triggers on main, and calls the test workflow inside of it already
+    tags-ignore:
+      - v* # exclude tags, since deploy workflow triggers on tags, and calls the test workflow inside of it already
+
+jobs:
+  suite:
+    uses: ./.github/workflows/.test.yml

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/git/best-practice/.gitignore.declapract.ts

@@ -3,6 +3,7 @@ import expect from 'expect';
 import uniq from 'lodash.uniq';
 
 const expectedIgnores = [
+  '*.log',
   '.artifact', // deployment artifacts from `simple-artifact-builder` are produced here
   '.env',
   '.serverless',

package/dist/practices/terraform/best-practice/provision/aws/product/variables.tf

@@ -12,3 +12,10 @@ locals {
     product     = local.service
   }
 }
+
+data "aws_caller_identity" "current" {}
+data "aws_region" "current" {}
+locals {
+  aws_account_id = data.aws_caller_identity.current.account_id
+  aws_region     = data.aws_region.current.name
+}

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/useCases.yml

@@ -2,7 +2,7 @@
 use-cases:
   typescript-project:
     practices:
-      - cicd-integrate
+      - cicd-common
       - conventional-commits
       - directory-structure-src
       - domain
@@ -22,14 +22,14 @@ use-cases:
     extends:
       - typescript-project
     practices:
-      - cicd-deploy-package
+      - cicd-package
       - node-package
   lambda-service:
     extends:
       - typescript-project
     practices:
       - artifact
-      - cicd-deploy-service
+      - cicd-service
       - config
       - dates-and-times
       - environments-aws

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.22.8",
+  "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/cicd-deploy-package/best-practice/.github/workflows/publish.yml

@@ -1,21 +0,0 @@
-name: publish
-
-on:
-  push:
-    tags:
-      - v*
-
-jobs:
-  test:
-    uses: ./.github/workflows/.test.yml
-    with:
-      aws-region: us-east-1
-      aws-account-id: '@declapract{variable.awsAccountId.dev}'
-    secrets:
-      aws-access-key-id: ${{ secrets.DEV_AWS_ACCESS_KEY_ID }}
-      aws-secret-access-key: ${{ secrets.DEV_AWS_SECRET_ACCESS_KEY }}
-
-  publish:
-    uses: ./.github/workflows/.publish-npm.yml
-    secrets:
-      npm-auth-token: ${{ secrets.NPM_TOKEN }}

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"
-  }
-}