Merge pull request #54 from shiftcode/#53-basic-ts-guards

#53 basic ts guards

Author: michaelwittwer

.github/workflows/main.yml

@@ -93,6 +93,9 @@ jobs:
       # build lint plugins before linting
       - name: Build lint plugins
         run: npm run build:lint:ci
+      # check formatting
+      - name: Check Formatting
+        run: npm run format:ci
       # lint
       - name: Lint
         run: npm run lint:ci

package-lock.json

@@ -11,9 +11,10 @@
   "scripts": {
     "build:ci": "lerna run build",
     "build:lint:ci": "lerna run build:lint:ci",
+    "format": "lerna run format",
+    "format:ci": "lerna run format:ci",
     "lint:ci": "lerna run lint:ci",
     "prepare": "husky",
-    "prettier": "lerna run prettier",
     "publish-libs": "node packages/publish-helper/dist/publish-lib",
     "test:ci": "lerna run test:ci"
   },

package.json

@@ -1,7 +1,6 @@
-# we use eslint instead of ng lint, because we can't use --project (tsconfig specifying files with include, exclude)
-# and --files argument pointing to other files
-src/{**/,}*.ts,test/{**/,}*.ts:
-  - npm run prettier:staged
+# Reformat all .ts / .js
+"**/*.(t|j)s":
+  - npm run format:staged
   - npm run lint:staged
 
 # sort package.json keys

packages/branch-utilities/.lintstagedrc.yml

@@ -1,6 +1,6 @@
 {
   "name": "@shiftcode/branch-utilities",
-  "version": "5.0.0",
+  "version": "5.0.1-pr53.1",
   "description": "Utilities for local and ci to get branch name and stage",
   "repository": "https://github.com/shiftcode/sc-commons-public",
   "license": "MIT",
@@ -16,13 +16,15 @@
   "scripts": {
     "prebuild": "rm -rf ./dist",
     "build": "tsc",
+    "format": "npm run format:base -- --write",
+    "format:base": "prettier --config ../../.prettierrc.yml '{src,e2e,test}/**/*.ts'",
+    "format:ci": "npm run format:base -- --check",
+    "format:staged": "prettier --write --config ../../.prettierrc.yml",
     "lint": "npm run lint:src:fix",
     "lint:ci": "npm run lint:src",
     "lint:src": "eslint ./src",
     "lint:src:fix": "eslint ./src --cache --fix",
     "lint:staged": "eslint --fix --cache",
-    "prettier": "prettier --write --config ../../.prettierrc.yml '{src,e2e,test}/**/*.ts'",
-    "prettier:staged": "prettier --write --config ../../.prettierrc.yml",
     "prepublish": "node ../publish-helper/dist/prepare-dist.js",
     "test": "NODE_OPTIONS=\"--experimental-vm-modules --trace-warnings\" npx jest --config jest.config.js",
     "test:ci": "npm run test",

packages/branch-utilities/package.json

@@ -81,9 +81,10 @@ describe('base utils', () => {
   })
 
   describe('parseBranchName', () => {
-
     test('works when valid pattern', () => {
-      expect(parseBranchName('#7-abc')).toEqual({ branchId: 7, branchName: 'abc' } satisfies ReturnType<typeof parseBranchName>)
+      expect(parseBranchName('#7-abc')).toEqual({ branchId: 7, branchName: 'abc' } satisfies ReturnType<
+        typeof parseBranchName
+      >)
 
       expect(parseBranchName('#72-abc').branchId).toBe(72)
       expect(parseBranchName('#000-int').branchId).toBe(0)
@@ -94,8 +95,12 @@ describe('base utils', () => {
     })
 
     test('works for github copilot created branches', () => {
-      expect(parseBranchName('copilot/fix-123')).toEqual({ branchId: 123, branchName: 'fix' } satisfies ReturnType<typeof parseBranchName>)
-      expect(parseBranchName('copilot/feat-123')).toEqual({ branchId: 123, branchName: 'feat' } satisfies ReturnType<typeof parseBranchName>)
+      expect(parseBranchName('copilot/fix-123')).toEqual({ branchId: 123, branchName: 'fix' } satisfies ReturnType<
+        typeof parseBranchName
+      >)
+      expect(parseBranchName('copilot/feat-123')).toEqual({ branchId: 123, branchName: 'feat' } satisfies ReturnType<
+        typeof parseBranchName
+      >)
     })
 
     test('throws when invalid pattern', () => {

packages/branch-utilities/src/lib/base.utils.spec.ts

@@ -90,9 +90,11 @@ export function getBranchInfo(env: unknown, branchName?: string): BranchInfo {
 }
 
 export function isFullBranchOverrideDefined(envVars: unknown): envVars is CustomScOverrideEnv {
-  return envVars !== null
-    && typeof (envVars as CustomScOverrideEnv).SC_OVERRIDE_BRANCH_NAME ==='string'
-    && typeof (envVars as CustomScOverrideEnv).SC_OVERRIDE_IS_PR ==='string'
+  return (
+    envVars !== null &&
+    typeof (envVars as CustomScOverrideEnv).SC_OVERRIDE_BRANCH_NAME === 'string' &&
+    typeof (envVars as CustomScOverrideEnv).SC_OVERRIDE_IS_PR === 'string'
+  )
 }
 
 export function getBranchNameOverride(env: CustomScOverrideEnv): string {

packages/branch-utilities/src/lib/base.utils.ts

@@ -1,7 +1,6 @@
-# we use eslint instead of ng lint, because we can't use --project (tsconfig specifying files with include, exclude)
-# and --files argument pointing to other files
-src/{**/,}*.ts,test/{**/,}*.ts:
-  - npm run prettier:staged
+# Reformat all .ts / .js
+"**/*.(t|j)s":
+  - npm run format:staged
   - npm run lint:staged
 
 # sort package.json keys

packages/eslint-config-recommended/.lintstagedrc.yml

@@ -1,6 +1,6 @@
 {
   "name": "@shiftcode/eslint-config-recommended",
-  "version": "5.0.0",
+  "version": "5.0.1-pr53.1",
   "description": "default shiftcode config for eslint",
   "repository": "https://github.com/shiftcode/sc-commons-public",
   "license": "UNLICENSED",
@@ -24,19 +24,21 @@
     "prebuild": "rm -rf ./dist",
     "build": "tsc",
     "build:lint:ci": "npm run build",
+    "format": "npm run format:base -- --write",
+    "format:base": "prettier --config ../../.prettierrc.yml '{src,e2e,test}/**/*.ts'",
+    "format:ci": "npm run format:base -- --check",
+    "format:staged": "prettier --write --config ../../.prettierrc.yml",
     "lint": "npm run lint:src:fix",
     "lint:ci": "npm run lint:src",
     "lint:src": "eslint ./src",
     "lint:src:fix": "eslint ./src --cache --fix",
     "lint:staged": "eslint --fix --cache",
-    "prettier": "prettier --write --config ../../.prettierrc.yml '{src,e2e,test}/**/*.ts'",
-    "prettier:staged": "prettier --write --config ../../.prettierrc.yml",
     "prepublish": "node ../publish-helper/dist/prepare-dist.js",
     "test": "echo 'Error: no test specificed'",
     "test:ci": "npm run test"
   },
   "dependencies": {
-    "@shiftcode/eslint-plugin-rules": "^4.0.0",
+    "@shiftcode/eslint-plugin-rules": "^4.0.1-pr53.1",
     "@typescript-eslint/eslint-plugin": "^8.18.0",
     "@typescript-eslint/parser": "^8.18.0",
     "eslint": "^8.56.0",

packages/eslint-config-recommended/package.json

@@ -1,7 +1,6 @@
-# we use eslint instead of ng lint, because we can't use --project (tsconfig specifying files with include, exclude)
-# and --files argument pointing to other files
-src/{**/,}*.ts,test/{**/,}*.ts:
-  - npm run prettier:staged
+# Reformat all .ts / .js
+"**/*.(t|j)s":
+  - npm run format:staged
   - npm run lint:staged
 
 # sort package.json keys