Publish garbo lib (#1639)

* Publish garbo-lib to npm

* Include repo link for garbo-lib

* garbo-lib doesn't need to be run directly in mafia

* Build garbo-lib before checking garbo

* Add prettierignore

.github/workflows/garbo-lib.yml

@@ -0,0 +1,29 @@
+name: Publish package to NPM
+on:
+  push:
+    paths:
+      - "packages/garbo-lib/package.json"
+    branches:
+      - main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: "16.x"
+          registry-url: "https://registry.npmjs.org"
+
+      - name: Check publish status
+        id: check
+        uses: tehpsalmist/npm-publish-status-action@v1
+
+      - name: Publish if necessary
+        if: ${{ steps.check.outputs.exists == '0' }}
+        run: |
+          yarn
+          yarn workspace garbo-lib run publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/garbo.yml

@@ -25,6 +25,7 @@ jobs:
           node-version: ${{ env.node-version }}
           cache: yarn
       - run: yarn install --frozen-lockfile
+      - run: yarn workspace garbo-lib build
       - run: yarn workspace garbo run check
       #- run: yarn run test TODO: Readd once we have tests
 
@@ -39,6 +40,7 @@ jobs:
           node-version: ${{ env.node-version }}
           cache: yarn
       - run: yarn install --frozen-lockfile
+      - run: yarn workspace garbo-lib build
       - run: yarn run lint
 
   circular-dependencies-script:
@@ -52,6 +54,7 @@ jobs:
           node-version: ${{ env.node-version }}
           cache: yarn
       - run: yarn install --frozen-lockfile
+      - run: yarn workspace garbo-lib build
       - run: yarn workspace garbo run madge
 
   deploy:

package.json

@@ -7,7 +7,7 @@
   "scripts": {
     "build": "yarn workspaces foreach -ptv run build && yarn run combineFiles",
     "combineFiles": "copyfiles --up 2 \"packages/garbo/dist/**\" .; copyfiles --up 2 \"packages/garbo-relay/dist/**\" .",
-    "format": "yarn workspaces foreach -pv run format",
+    "format": "yarn run prettier --write .github && yarn workspaces foreach -pv run format",
     "lint": " yarn workspaces foreach -pv run lint",
     "pre-commit": "yarn workspaces foreach -v run pre-commit",
     "prepare": "husky install"

packages/garbo-lib/.prettierignore

@@ -0,0 +1 @@
+dist

packages/garbo-lib/package.json

@@ -2,29 +2,34 @@
   "name": "garbo-lib",
   "version": "0.0.1",
   "license": "MIT",
+  "repository": "https://github.com/loathers/garbage-collector.git",
   "description": "A library for sequencing turns resource-optimally",
-  "main": "src/index.ts",
+  "main": "dist/index.js",
   "scripts": {
-    "build": "echo \"Nothing to do\"",
+    "build": "tsc",
     "format": "eslint src --fix && prettier --write .",
     "lint": "eslint src && prettier --check .",
-    "pre-commit": "lint-staged"
+    "pre-commit": "lint-staged",
+    "prepublishOnly": "yarn run build"
   },
   "lint-staged": {
     "*": [
       "prettier --write --ignore-unknown",
       "eslint --quiet --fix"
     ]
   },
-  "dependencies": {
+  "peerDependencies": {
     "kolmafia": "^5.27628.0",
     "libram": "^0.8.13"
   },
   "devDependencies": {
     "eslint": "^8.50.0",
     "eslint-config-garbo": "^0.0.1",
+    "kolmafia": "^5.27628.0",
+    "libram": "^0.8.13",
     "lint-staged": "^14.0.1",
-    "prettier": "^3.0.3"
+    "prettier": "^3.0.3",
+    "typescript": "^5.2.2"
   },
   "eslintConfig": {
     "extends": "eslint-config-garbo"

packages/garbo-lib/tsconfig.json

@@ -1,17 +1,17 @@
 {
   "compilerOptions": {
     "experimentalDecorators": true,
-    "noEmit": true,
     "allowUnreachableCode": false,
     "allowUnusedLabels": false,
-    "declaration": false,
+    "declaration": true,
     "forceConsistentCasingInFileNames": true,
-    "lib": ["ES2019"],
+    "lib": ["ES2020"],
     "module": "commonjs",
     "noEmitOnError": true,
     "noFallthroughCasesInSwitch": true,
     "noImplicitReturns": true,
     "pretty": true,
+    "outDir": "dist",
     "strict": true,
     "target": "esnext",
     "skipLibCheck": true

yarn.lock

@@ -4258,6 +4258,10 @@ __metadata:
     libram: ^0.8.13
     lint-staged: ^14.0.1
     prettier: ^3.0.3
+    typescript: ^5.2.2
+  peerDependencies:
+    kolmafia: ^5.27628.0
+    libram: ^0.8.13
   languageName: unknown
   linkType: soft