@hedia/types 2.1.61-alpha.0 → 2.1.61-alpha.2

package/.github/pull_request_template.md

@@ -1,6 +1,7 @@
 <!--
-⚠️⚠️ If pointing to master ⚠️⚠️
------------------------------
-- Remember to include HDA on the PR title
-- Remember to set the Label
+⚠️⚠️ For PRs towards master ⚠️⚠️
+----------------------------------
+- Remember to prefix PR title with 'HDA-'.
+- Remember to set one or more of the following labels: 'feature', 'fix', 'test'.
+- Remember to set one of the following labels: 'major', 'minor', 'patch'.
 --!>

package/.github/workflows/ci.yaml

@@ -2,86 +2,11 @@ name: CI
 
 on:
   pull_request:
-    branches:
-      - master
     types: [opened, reopened, synchronize]
 
-env:
-  NPM_TOKEN: ${{ secrets.HEDIA_BOT_NPM_TOKEN }}
-
 jobs:
-  ## Defines if following CI steps should be skipped due to autobump commit
-  should-skip:
-    runs-on: ubuntu-latest
-    outputs:
-      skip: ${{ steps.ci-skip.outputs.ci-skip }}
-      
-    steps:
-      - uses: actions/checkout@v2
-        with:
-          fetch-depth: "1000"
-
-      - name: Should skip CI
-        id: ci-skip
-        uses: mstachniuk/ci-skip@v1
-        with:
-          commit-filter: "autobump"
-
-  ## PR labels validation
-  validate-pr-labels:
-    needs: [should-skip]
-    runs-on: ubuntu-latest
-    if: ${{ needs.should-skip.outputs.skip == 'false' }}
-
-    steps:
-      - name: Validate PR labels
-        uses: docker://agilepathway/pull-request-label-checker:latest
-        with:
-          one_of: major,minor,patch
-          repo_token: ${{ secrets.HEDIA_BOT_GITHUB_PAT }}
-
-  ## Running tests & linting scripts
-  lint-and-test:
-    needs: [validate-pr-labels]
-    runs-on: ubuntu-latest
-    if: ${{ needs.should-skip.outputs.skip == 'false' }}
-
-    steps:
-      - uses: actions/checkout@v2
-
-      - name: Setup Node.js
-        uses: actions/setup-node@v2
-        with:
-          node-version: "14.15"
-
-      - name: Register NPM access token
-        run: npm config set '//registry.npmjs.org/:_authToken' "${NPM_TOKEN}"
-        env:
-          NPM_TOKEN: ${{ env.NPM_TOKEN }}
-
-      - run: npm ci --ignore-scripts
-      - run: npm run pkg-json-lint
-      - run: npm run prettier
-      - run: npm run tslint
-      - run: npm run tsc
-      
-  ## Bump version (if needed) & publish alpha package 
-  version-bump-publish-alpha:
-    needs: [lint-and-test]
-    runs-on: ubuntu-latest
-    if: ${{ needs.should-skip.outputs.skip == 'false' }}
-
-    steps:
-      - uses: actions/checkout@v2
-        with:
-          ref: ${{ github.event.pull_request.head.ref }}
-          token: ${{ secrets.HEDIA_BOT_GITHUB_PAT }}
-
-      - name: Autobump & Publish
-        uses: hedia-team/autobump-and-publish@master
-        with:
-          github-token: ${{ secrets.HEDIA_BOT_GITHUB_PAT }}
-          npm-token: ${{ env.NPM_TOKEN }}
-          git-name: "hedia-bot"
-          label: ${{ toJson(github.event.pull_request.labels.*.name) }} ## Defines type of version bump
-          issue-number: ${{ github.event.number }} ## So that publish comment can be written on PR
+  ci:
+    uses: hedia-team/service-workflows/.github/workflows/ci-package.yaml@hda-2122-update-package-shared-workflows
+    secrets:
+      NPM_TOKEN: ${{ secrets.HEDIA_BOT_NPM_TOKEN }}
+      GITHUB_PAT: ${{ secrets.HEDIA_BOT_GITHUB_PAT }}

package/.github/workflows/publish-release-package.yaml

@@ -0,0 +1,16 @@
+name: Publish release version of package to npm
+
+on:
+  pull_request:
+    branches:
+      - master
+    types: [closed]
+
+jobs:
+  publish-release-package:
+    if: github.event.pull_request.merged == true
+
+    uses: hedia-team/service-workflows/.github/workflows/publish-release-package.yaml@hda-2122-update-package-shared-workflows
+    secrets:
+      NPM_TOKEN: ${{ secrets.HEDIA_BOT_NPM_TOKEN }}
+      GITHUB_PAT: ${{ secrets.HEDIA_BOT_GITHUB_PAT }}

package/.github/workflows/validate-pr-title.yaml

@@ -2,19 +2,8 @@ name: Validate PR title
 
 on:
   pull_request:
-    branches:
-      - master
-    types: [opened, reopened, edited]
-
-permissions:
-  pull-requests: read
+    types: [opened, reopened, synchronize, edited]
 
 jobs:
   validate-pr-title:
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Validate PR title
-        uses: deepakputhraya/action-pr-title@master
-        with:
-          regex: "^(((\\[\\d+\\.\\d+\\.\\d+\\])|(\\[Anytime\\]))\\s-\\s)?HDA-\\d+.*"
+    uses: hedia-team/service-workflows/.github/workflows/validate-pr-title.yaml@hda-2122-update-package-shared-workflows

package/.npmpackagejsonlintrc.json

@@ -1,12 +1,12 @@
 {
-    "rules": {
-      "no-caret-version-dependencies": "error",
-      "no-caret-version-devDependencies": "error",
-      "no-duplicate-properties": "error",
-      "no-repeated-dependencies": "error",
-      "no-tilde-version-dependencies": "error",
-      "no-tilde-version-devDependencies": "error",
-      "prefer-alphabetical-dependencies": "error",
-      "prefer-alphabetical-devDependencies": "error"
-    }
-  }
+	"rules": {
+		"no-caret-version-dependencies": "error",
+		"no-caret-version-devDependencies": "error",
+		"no-duplicate-properties": "error",
+		"no-repeated-dependencies": "error",
+		"no-tilde-version-dependencies": "error",
+		"no-tilde-version-devDependencies": "error",
+		"prefer-alphabetical-dependencies": "error",
+		"prefer-alphabetical-devDependencies": "error"
+	}
+}

package/.prettierignore

@@ -0,0 +1,3 @@
+dist/
+src/**/*.d.ts
+src/**/*.guard.ts

package/.prettierrc

@@ -1,25 +1,25 @@
 {
-    "arrowParens": "always",
-    "bracketSpacing": true,
-    "cursorOffset": 2,
-    "endOfLine": "lf",
-    "filepath": "none",
-    "htmlWhitespaceSensitivity": "ignore",
-    "insertPragma": false,
-    "jsxBracketSameLine": false,
-    "jsxSingleQuote": false,
-    "overrides": [],
-    "parser": "typescript",
-    "plugins": [],
-    "pluginSearchDirs": [],
-    "printWidth": 120,
-    "proseWrap": "preserve",
-    "quoteProps": "preserve",
-    "requirePragma": false,
-    "semi": true,
-    "singleQuote": false,
-    "tabWidth": 4,
-    "trailingComma": "all",
-    "useTabs": true,
-    "vueIndentScriptAndStyle": false
+	"arrowParens": "always",
+	"bracketSpacing": true,
+	"cursorOffset": 2,
+	"endOfLine": "lf",
+	"filepath": "none",
+	"htmlWhitespaceSensitivity": "ignore",
+	"insertPragma": false,
+	"bracketSameLine": false,
+	"jsxSingleQuote": false,
+	"overrides": [],
+	"parser": "typescript",
+	"plugins": [],
+	"pluginSearchDirs": [],
+	"printWidth": 120,
+	"proseWrap": "preserve",
+	"quoteProps": "preserve",
+	"requirePragma": false,
+	"semi": true,
+	"singleQuote": false,
+	"tabWidth": 4,
+	"trailingComma": "all",
+	"useTabs": true,
+	"vueIndentScriptAndStyle": false
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hedia/types",
-  "version": "2.1.61-alpha.0",
+  "version": "2.1.61-alpha.2",
   "description": "Enums, interfaces, and other common types for use in Hedia's software.",
   "main": "dist/index.js",
   "repository": {
@@ -8,25 +8,28 @@
     "url": "git+ssh://git@github.com:hedia-team/hedia-types.git"
   },
   "scripts": {
-    "tsc": "tsc",
-    "build": "tsc --build",
-    "clean": "tsc --build --clean",
-    "tslint": "tslint --project .",
-    "tslint-fix": "tslint --fix --project . ",
-    "prettier": "prettier --check \"types/**/*.{ts,tsx}\"",
-    "prettier-fix": "prettier --write \"types/**/*.{ts,tsx}\"",
+    "test": "",
+    "tsc": "tsc --noEmit",
+    "build": "rm -rf dist/ && tsc --build",
+    "clean": "tsc --build --clean && rm -rf dist/",
+    "build-guards": "ts-auto-guard src/**/[!index]*.ts",
+    "lint": "tslint --project .",
+    "lint-fix": "tslint --fix --project .",
+    "prettier": "prettier --check \"**/*.{ts,tsx}\"",
+    "prettier-fix": "prettier --write \"**/*.{ts,tsx}\"",
     "pkg-json-lint": "npmPkgJsonLint .",
-    "package-audit": "npm-audit --high --critical",
-    "postpublish": "npm run clean",
-    "prepublishOnly": "npm ci && npm run tsc"
+    "package-audit": "npm-audit --critical",
+    "prepublishOnly": "npm ci --ignore-scripts && npm run build",
+    "postpublish": "npm run clean"
   },
   "keywords": [],
   "author": "Hedia",
   "license": "ISC",
   "homepage": "https://github.com/hedia-team/hedia-types#readme",
   "devDependencies": {
+    "@hedia/npm-audit-pipeline": "0.5.0",
     "npm-package-json-lint": "5.4.0",
-    "prettier": "2.4.1",
+    "prettier": "2.5.1",
     "tslint": "6.1.3",
     "tslint-config-prettier": "1.18.0",
     "typescript": "4.1.5"