declapract-typescript-ehmpathy 0.35.9 → 0.36.0

package/dist/practices/cicd-app-react-native-expo/best-practice/.github/workflows/.deploy-expo.yml

@@ -0,0 +1,152 @@
+name: .deploy-expo
+
+on:
+  workflow_call:
+    inputs:
+      stage:
+        type: string
+        description: 'the stage of infrastructure to deploy against (e.g., prod, dev)'
+        required: true
+      build:
+        type: string
+        description: 'the build to deploy (e.g., production, preview, development)'
+        required: true
+      github-environment:
+        type: string
+        description: 'the github environment that the apply step will be executed in'
+        required: true
+      aws-region:
+        type: string
+        description: the aws region within which we should access
+        required: true
+      aws-account-id:
+        type: string
+        description: the id of the account the credentials are expected to access
+        required: true
+      needs-vpn-for-acceptance:
+        type: boolean
+        description: whether or not this environment needs vpn access for acceptance tests
+        required: false
+        default: false
+      app-web-deployment-s3-bucket:
+        type: string
+        description: the s3 bucket within which the web app is deployed
+        required: false
+
+    secrets:
+      expo-token:
+        required: true
+        description: required credentials to authenticate with expo eas
+      aws-access-key-id:
+        required: true
+        description: required credentials to authenticate with aws provider and state persistance
+      aws-secret-access-key:
+        required: true
+        description: required credentials to authenticate with aws provider and state persistance
+      open-vpn-config:
+        required: false
+        description: complete openvpn config required to enter the vpn, if needed
+
+jobs:
+  deploy-os:
+    strategy:
+      matrix:
+        platform: [ios, android]
+    name: ${{ matrix.platform }}
+    runs-on: ubuntu-latest
+    if: ${{ inputs.stage == 'prod' }}
+    steps:
+      - name: checkout
+        uses: actions/checkout@v3
+
+      - name: set node-version
+        uses: actions/setup-node@v3
+        with:
+          node-version-file: '.nvmrc'
+
+      - name: configure aws credentials
+        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: ${{ inputs.aws-region }}
+
+      - name: confirm aws credentials
+        run: |
+          [[ ${{steps.credentials.outputs.aws-account-id}} != ${{ inputs.aws-account-id }} ]] \
+            && echo 'wrong aws account' && exit 1 \
+            || echo 'correct aws account';
+
+      - name: node-modules cache get
+        uses: actions/cache/restore@v4
+        id: cache
+        with:
+          path: ./node_modules
+          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+
+      - name: node-modules cache miss install
+        if: steps.cache.outputs.cache-hit != 'true'
+        run: npm ci --ignore-scripts --prefer-offline --no-audit
+
+      - name: setup expo
+        uses: expo/expo-github-action@v8
+        with:
+          eas-version: latest
+          token: ${{ secrets.expo-token }}
+
+      - name: deploy ota update
+        run: eas update --auto --channel ${{ inputs.build }} --platform ${{ matrix.platform }} --non-interactive
+
+      - name: deploy app binary
+        run: eas build --profile ${{ inputs.build }} --platform ${{ matrix.platform }} --non-interactive --no-wait ${{ inputs.build == 'production' && '--auto-submit' || '' }}
+
+  deploy-web:
+    name: web
+    runs-on: ubuntu-latest
+    if: ${{ inputs.stage == 'prod' && inputs.app-web-deployment-s3-bucket }}
+    steps:
+      - name: checkout
+        uses: actions/checkout@v3
+
+      - name: set node-version
+        uses: actions/setup-node@v3
+        with:
+          node-version-file: '.nvmrc'
+
+      - name: configure aws credentials
+        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: ${{ inputs.aws-region }}
+
+      - name: confirm aws credentials
+        run: |
+          [[ ${{steps.credentials.outputs.aws-account-id}} != ${{ inputs.aws-account-id }} ]] \
+            && echo 'wrong aws account' && exit 1 \
+            || echo 'correct aws account';
+
+      - name: node-modules cache get
+        uses: actions/cache/restore@v4
+        id: cache
+        with:
+          path: ./node_modules
+          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+
+      - name: node-modules cache miss install
+        if: steps.cache.outputs.cache-hit != 'true'
+        run: npm ci --ignore-scripts --prefer-offline --no-audit
+
+      - name: setup expo
+        uses: expo/expo-github-action@v8
+        with:
+          eas-version: latest
+          token: ${{ secrets.expo-token }}
+
+      - name: compile
+        run: npm run build:web
+
+      - name: deploy
+        run: aws s3 sync ./dist ${{ inputs.web-deployment-s3-bucket }} --delete --cache-control max-age=60,stale-while-revalidate=604800 # todo: fine tune the cache control; https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cache-Control#stale-while-revalidate

package/dist/practices/cicd-app-react-native-expo/best-practice/.github/workflows/deploy.yml

@@ -0,0 +1,55 @@
+name: deploy
+
+on:
+  push:
+    tags:
+      - v*
+    branches:
+      - 'main'
+      - 'master'
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }} # per [workflow] x [branch, tag]
+  cancel-in-progress: true # only cancel work flows on non-latest commits
+
+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 }}
+
+  # todo: start deploying dev builds for testing... want to be smart regarding how often we do this though -> e.g., no need to waste builds ($3 per build)
+  # dev:
+  #   uses: ./.github/workflows/.deploy-expo.yml
+  #   if: github.ref == 'refs/heads/main' &&  !contains(github.event.head_commit.message, 'chore(release)')
+  #   needs: [test]
+  #   with:
+  #     stage: dev
+  #     build: development
+  #     github-environment: dev
+  #     aws-region: us-east-1
+  #     aws-account-id: '@declapract{variable.awsAccountId.dev}'
+  #   secrets:
+  #     expo-token: ${{ secrets.EXPO_TOKEN }}
+  #     aws-access-key-id: ${{ secrets.DEV_AWS_ACCESS_KEY_ID }}
+  #     aws-secret-access-key: ${{ secrets.DEV_AWS_SECRET_ACCESS_KEY }}
+
+  prod:
+    uses: ./.github/workflows/.deploy-expo.yml
+    if: startsWith(github.ref, 'refs/tags/')
+    needs: [test]
+    with:
+      stage: prod
+      build: production
+      github-environment: prod
+      aws-region: us-east-1
+      aws-account-id: '@declapract{variable.awsAccountId.prod}'
+      app-web-deployment-s3-bucket: s3://@declapract{variable.projectName}-@declapract{variable.infrastructureNamespaceId}-prod'
+    secrets:
+      expo-token: ${{ secrets.EXPO_TOKEN }}
+      aws-access-key-id: ${{ secrets.PROD_AWS_ACCESS_KEY_ID }}
+      aws-secret-access-key: ${{ secrets.PROD_AWS_SECRET_ACCESS_KEY }}

package/dist/practices/cicd-app-react-native-expo/best-practice/.github/workflows/test.yml

@@ -0,0 +1,23 @@
+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
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }} # per [workflow] x [branch, tag]
+  cancel-in-progress: true #  cancel workflows for non-latest commits
+
+jobs:
+  suite:
+    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 }}

package/dist/practices/cicd-app-react-native-expo/best-practice/package.json

@@ -0,0 +1,43 @@
+{
+  "jest": {
+    "preset": "jest-expo"
+  },
+  "dependencies": {
+    "expo": "@declapract{check.minVersion('51.0.22')}",
+    "expo-dev-client": "@declapract{check.minVersion('4.0.20')}",
+    "expo-updates": "@declapract{check.minVersion('0.25.21')}"
+  },
+  "devDependencies": {
+    "jest-expo": "@declapract{check.minVersion('51.0.3')}"
+  },
+  "scripts": {
+    "start:hot:proxy": "npx local-ssl-proxy --source 3447 --target 8081",
+    "start:hot:dev": "STAGE=dev npx expo start --clear --dev-client",
+    "start:hot:dev:link": "echo '🚀 https://localhost.@declapract{variable.app.web.domain.dev}:@declapract{variable.app.web.port.hot}'",
+    "start:hot:dev:proxy": "npm run start:hot:dev:link && npm run start:hot:proxy",
+    "start:hot:prod": "STAGE=prod npx expo start --clear --dev-client",
+    "start:hot:prod:link": "echo '🚀 https://localhost.@declapract{variable.app.web.domain.prod}:@declapract{variable.app.web.port.hot}'",
+    "start:hot:prod:proxy": "npm run start:hot:prod:link && npm run start:hot:proxy",
+    "start:cold:proxy": "npx local-ssl-proxy --source 3449 --target 3000",
+    "start:cold:dev": "npm run build:web && npx serve dist --single",
+    "start:cold:dev:link": "echo '🚀 https://localhost.@declapract{variable.app.web.domain.dev}:@declapract{variable.app.web.port.cold}'",
+    "start:cold:dev:proxy": "echo npm run start:cold:dev:link && npm run start:cold:proxy",
+    "start:cold:prod": "npm run build:web && npx serve dist --single",
+    "start:cold:prod:link": "echo '🚀 https://localhost.@declapract{variable.app.web.domain.prod}:@declapract{variable.app.web.port.cold}'",
+    "register:device:apple:info": "echo 'learn more here https://docs.expo.dev/build/internal-distribution/'",
+    "register:device:apple:inclusions:rebuild:prod": "npx eas build --platform ios --clear-cache",
+    "register:device:apple:inclusions:rebuild:dev": "npx eas build --profile development --platform ios --clear-cache",
+    "register:device:apple:add": "echo 'register an apple device to allow it to install internal builds' && eas device:create && npm run register:device:apple:inclusions:rebuild",
+    "register:device:apple:list": "eas device:list",
+    "register:device:apple:delete": "eas device:delete",
+    "register:device:apple:rename": "eas device:rename",
+    "register:profile:apple:list": "echo 'see list here https://developer.apple.com/account/resources/profiles/list'",
+    "build:dev:ios": "eas build --profile development --platform ios --non-interactive",
+    "build:dev:android": "eas build --profile development --platform android --non-interactive",
+    "build:web": "npx expo export --platform web",
+    "deploy:prod:ios:metadata": "eas metadata:push",
+    "deploy:prod": "echo 'use github actions'",
+    "open:store:android": "https://play.google.com/console/u/0/developers/",
+    "open:store:ios": "browser https://appstoreconnect.apple.com/apps/"
+  }
+}

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

@@ -0,0 +1,4 @@
+// eslint-disable-next-line import/no-extraneous-dependencies
+import { FileCheckType } from 'declapract';
+
+export const check = FileCheckType.CONTAINS;

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

@@ -0,0 +1,4 @@
+// eslint-disable-next-line import/no-extraneous-dependencies
+import { FileCheckType } from 'declapract';
+
+export const check = FileCheckType.CONTAINS;

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

@@ -0,0 +1,7 @@
+{
+  "devDependencies": {
+    "eslint-plugin-jsx-a11y": "6.7.1",
+    "eslint-plugin-react": "7.33.2",
+    "eslint-plugin-react-hooks": "4.6.0"
+  }
+}

package/dist/practices/lint-react-native/best-practice/.eslintrc.js

@@ -0,0 +1,56 @@
+module.exports = {
+  parser: '@typescript-eslint/parser', // Specifies the ESLint parser
+  extends: [
+    'plugin:@typescript-eslint/recommended', // Uses the recommended rules from the @typescript-eslint/eslint-plugin
+    'plugin:import/recommended', // specifies good import rules
+    'airbnb-typescript/base', // uses the airbnb recommended rules
+    'plugin:react/recommended',
+    'plugin:react-hooks/recommended',
+    'plugin:jsx-a11y/recommended',
+    'plugin:prettier/recommended', // Enables eslint-plugin-prettier and displays prettier errors as ESLint errors. Make sure this is always the last configuration in the extends array.
+  ],
+  parserOptions: {
+    project: './tsconfig.json',
+    ecmaVersion: 2018, // Allows for the parsing of modern ECMAScript features
+    sourceType: 'module', // Allows for the use of imports
+  },
+  rules: {
+    'import/extensions': 'off', // too many false positives; should figure out why
+    'react/react-in-jsx-scope': 'off', // https://stackoverflow.com/a/68315971/3068233
+    'react/no-unescaped-entities': 'off', // too invasive -> not seeing the value either
+    '@typescript-eslint/explicit-function-return-type': 'off', // this can be figured out implicitly, and that is better
+    'sort-imports': 'off',
+    'import/prefer-default-export': 'off', // default export = bad
+    'import/no-default-export': 'error', // require named exports - they make it easier to refactor, enforce consistency, and increase constraints
+    '@typescript-eslint/no-non-null-assertion': 'off', // we use these to help typescript out when we know something it doesnt, and cant easily express that
+    'import/no-extraneous-dependencies': [
+      'error',
+      {
+        devDependencies: [
+          '**/*.test.ts',
+          '**/*.test.integration.ts',
+          '**/*.test.acceptance.ts',
+          'acceptance/**/*.ts',
+          '**/__test_utils__/**/*.ts',
+          'provision/**/*.ts',
+        ],
+      },
+    ],
+    '@typescript-eslint/no-explicit-any': 'off', // sometimes this is a valid definition
+    '@typescript-eslint/no-unused-vars': ['warn', { argsIgnorePattern: '^_' }],
+    'import/no-cycle': 'off',
+    'max-classes-per-file': 'off',
+    '@typescript-eslint/no-use-before-define': 'off',
+    '@typescript-eslint/no-floating-promises': 'error',
+    'prefer-destructuring': 'off',
+    '@typescript-eslint/no-non-null-assertion': 'off',
+    'lines-between-class-members': 'off',
+    '@typescript-eslint/lines-between-class-members': 'off',
+    'no-return-await': 'off', // this does not help anything and actually leads to bugs if we subsequently wrap the return in a try catch without remembering to _then_ add await
+    '@typescript-eslint/return-await': 'off',
+    '@typescript-eslint/no-unsafe-declaration-merging': 'off',
+  },
+  settings: {
+    'import/ignore': ['react-native'], // https://github.com/facebook/react-native/issues/28549
+  },
+};

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

@@ -0,0 +1,5 @@
+{
+  "devDependencies": {
+    "eslint-plugin-react-native": "4.0.0"
+  }
+}

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

@@ -65,12 +65,44 @@ export const desiredRelativeKeyOrder = {
     'preversion',
     'postversion',
     'postinstall',
+    'prepare:husky',
     'deploy:prune',
     'deploy:release',
     'deploy:send-notification',
     'deploy:dev',
     'deploy:prod',
     'deploy',
+
+    // from app-react-native-expo
+    'start:hot:proxy',
+    'start:hot:dev',
+    'start:hot:dev:link',
+    'start:hot:dev:proxy',
+    'start:hot:prod',
+    'start:hot:prod:link',
+    'start:hot:prod:proxy',
+    'start:cold:proxy',
+    'start:cold:dev',
+    'start:cold:dev:link',
+    'start:cold:dev:proxy',
+    'start:cold:prod',
+    'start:cold:prod:link',
+    'register:device:apple:info',
+    'register:device:apple:inclusions:rebuild:prod',
+    'register:device:apple:inclusions:rebuild:dev',
+    'register:device:apple:add',
+    'register:device:apple:list',
+    'register:device:apple:delete',
+    'register:device:apple:rename',
+    'register:profile:apple:list',
+    'build:dev:ios',
+    'build:dev:android',
+    'build:web',
+    'deploy:prod:ios:metadata',
+    'open:store:android',
+    'open:store:ios',
+    'android',
+    'ios',
   ],
 };
 

package/dist/practices/terraform-common/best-practice/package.json.declapract.ts

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

package/dist/useCases.yml

@@ -10,7 +10,7 @@ use-cases:
       - errors
       - format
       - git
-      - linting
+      - lint
       - node
       - nonpublished-modules
       - package-json-order
@@ -40,7 +40,9 @@ use-cases:
       - node-service
       - runtime-type-checking
       - serverless
-      - terraform
+      - terraform-common
+      - terraform-github
+      - terraform-aws
       - tests-service
       - uuid
   lambda-service-with-rds:
@@ -55,3 +57,20 @@ use-cases:
       - lambda-service
     practices:
       - persist-with-dynamodb
+  app-react-native-expo:
+    practices:
+      - cicd-common
+      - cicd-app-react-native-expo
+      - conventional-commits
+      - husky
+      - format
+      - git
+      - node
+      - nonpublished-modules
+      - package-json-order
+      - prettier
+      - terraform-common
+      - terraform-github
+      - lint
+      - lint-react
+      - lint-react-native

package/package.json

@@ -2,7 +2,7 @@
   "name": "declapract-typescript-ehmpathy",
   "author": "ehmpathy",
   "description": "declapract best practices declarations for typescript",
-  "version": "0.35.9",
+  "version": "0.36.0",
   "license": "MIT",
   "main": "src/index.js",
   "repository": "ehmpathy/declapract-typescript-ehmpathy",
@@ -34,6 +34,7 @@
     "test": "npm run test:commits && npm run test:types && npm run test:format && npm run test:lint && npm run test:unit && npm run test:integration && npm run test:acceptance:locally && npm run test:validate",
     "test:acceptance": "npm run build && jest -c ./jest.acceptance.config.ts --forceExit --verbose --runInBand --passWithNoTests",
     "prepush": "npm run test && npm run build",
+    "prepublish": "npm run build",
     "preversion": "npm run prepush",
     "postversion": "git push origin HEAD --tags --no-verify",
     "postinstall": "[ -d .git ] && npm run prepare:husky || exit 0",