Move metadata to spago.yaml

Joel Lefkowitz · Joel Lefkowitz · commit b3f5625634d5 · 2024-05-06T17:49:16.000+01:00
diff --git a/.cspell.json b/.cspell.json
@@ -1,33 +1,35 @@
 {
   "language": "en",
-  "ignorePaths": [
-    ".git",
-    ".gitignore",
-    ".husky",
-    ".spago",
-    "*.aff",
-    "*.dic",
-    "coverage",
-    "dist",
-    "generated-docs",
-    "output",
-    "yarn-error.log"
+  "dictionaries": [
+    "aws",
+    "bash",
+    "en-gb",
+    "fullstack",
+    "misc",
+    "softwareTerms"
   ],
-  "dictionaries": ["bash", "en-gb", "misc", "node", "softwareTerms"],
+  "ignorePaths": [".git", "dicts"],
   "words": [
     "bumpversion",
     "codacy",
+    "corepack",
+    "dhall",
     "foldl",
     "forall",
+    "giphy",
     "joellefkowitz",
     "lefkowitz",
     "ncols",
+    "newtype",
     "nrows",
     "outfile",
     "purescript",
     "purs",
     "purty",
+    "repr",
     "spago",
+    "stringutils",
+    "trufflehog",
     "unfoldable"
   ]
 }
diff --git a/.github/actions/install/action.yml b/.github/actions/install/action.yml
@@ -10,33 +10,26 @@ runs:
   using: composite
   steps:
     - name: Checkout the source code
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
 
-    - name: Fetch yarn's cache directory path
-      id: yarn-cache-dir-path
+    - name: Enable corepack
       shell: bash
-      run: echo "YARN_CACHE_DIR=$(yarn cache dir)" >> $GITHUB_ENV
-
-    - name: Set up yarn package caching
-      uses: actions/cache@v3
-      id: yarn-cache
-      with:
-        path: ${{ env.YARN_CACHE_DIR }}
-        key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
-        restore-keys: |
-          ${{ runner.os }}-yarn-
+      run: corepack enable
 
     - name: Set the node version
-      uses: actions/setup-node@v3
+      uses: actions/setup-node@v4
       with:
         node-version: ${{ inputs.node-version }}
+        cache: yarn
+
+    - name: Install yarn dependencies
+      shell: bash
+      run: yarn install --immutable
 
-    - name: Install node dependencies
+    - name: Install spago dependencies
       shell: bash
-      run: |
-        yarn install --frozen-lockfile
-        yarn global add spago@0.93.0 purescript
+      run: yarn spago install
 
-    - name: Install PureScript dependencies
+    - name: Install trufflehog3
       shell: bash
-      run: spago install
+      run: pip install trufflehog3
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -5,11 +5,6 @@ on:
     tags:
       - "*.*.*"
 
-permissions:
-  contents: read
-  pages: write
-  id-token: write
-
 concurrency:
   group: "pages"
   cancel-in-progress: false
@@ -19,7 +14,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout the source code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Install dependencies
         uses: ./.github/actions/install
@@ -28,21 +23,23 @@ jobs:
         uses: actions/configure-pages@v4
 
       - name: Build the docs
-
-        # Use npx to invoke the local spago cli
-        run: npx spago docs
+        run: yarn spago docs
 
       - name: Upload the artifacts
         uses: actions/upload-pages-artifact@v3
         with:
           path: "generated-docs/html"
 
   deploy:
+    permissions:
+      pages: write
+      id-token: write
+
     runs-on: ubuntu-latest
     needs: build
 
     environment:
-      name: github-pages
+      name: Pages
       url: ${{ steps.deployment.outputs.page_url }}
 
     steps:
diff --git a/.github/workflows/review.yml b/.github/workflows/review.yml
@@ -7,7 +7,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout the source code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Install dependencies
         uses: ./.github/actions/install
@@ -16,4 +16,4 @@ jobs:
         run: npm run lint
 
       - name: Run tests
-        run: spago test
+        run: yarn spago test
diff --git a/.gitignore b/.gitignore
@@ -1,30 +1,9 @@
+.DS_Store
+.psc-ide-port
 .spago/
+.yarn/
 bower_components/
-node_modules/
-venv/
-
-build/
-coverage/
-dist/
 generated-docs/
+node_modules/
 output/
-tests_output/
-
-__pycache__/
-.mypy_cache/
-.nx/
-.pytest_cache/
-.terraform/
-
-*.coverage
-*.dblite
-*.egg-info/
-*.env*
-*.o
-*.pyc
-*.types
-
-.DS_Store
-.psc-ide-port
-.terraform.lock.hcl
 yarn-error.log
diff --git a/.husky/pre-commit b/.husky/pre-commit
@@ -1,2 +1,2 @@
 npm run lint
-spago test
+yarn spago test
diff --git a/.trufflehog3.yml b/.trufflehog3.yml
@@ -0,0 +1,33 @@
+severity: low
+exclude:
+  - message: Giphy links
+    pattern: media\.giphy\.com
+
+  - message: Shield links
+    pattern: img\.shields\.io
+
+  - message: Codacy references
+    pattern: "codacy_id:"
+
+  - message: Dictionaries
+    paths:
+      - en_US.aff
+
+  - message: Dependencies
+    paths:
+      - node_modules
+      - .spago
+
+  - message: Package management
+    paths:
+      - packages.dhall
+      - purs.json
+      - spago.yaml
+
+  - message: Tooling outputs
+    paths:
+      - generated-docs
+      - output
+      - spago.lock
+      - yarn-error.log
+      - yarn.lock
diff --git a/.yarnrc.yml b/.yarnrc.yml
@@ -0,0 +1 @@
+nodeLinker: node-modules
diff --git a/README.md b/README.md
@@ -18,20 +18,29 @@ Documentation and more detailed examples are hosted on [Github Pages](https://jo
 
 ## Tooling
 
+### Dependencies
+
+To install dependencies:
+
+```bash
+yarn install
+yarn spago install
+```
+
 ### Tests
 
 To run tests:
 
 ```bash
-spago test
+yarn spago test
 ```
 
 ### Documentation
 
 To generate the documentation locally:
 
 ```bash
-spago docs
+yarn spago docs
 ```
 
 ### Linters
@@ -70,8 +79,8 @@ bump2version patch
 
 Lots of love to the open source community!
 
-<p align='center'>
+<div align='center'>
     <img width=200 height=200 src='https://media.giphy.com/media/osAcIGTSyeovPq6Xph/giphy.gif' alt='Be kind to your mind' />
     <img width=200 height=200 src='https://media.giphy.com/media/KEAAbQ5clGWJwuJuZB/giphy.gif' alt='Love each other' />
     <img width=200 height=200 src='https://media.giphy.com/media/WRWykrFkxJA6JJuTvc/giphy.gif' alt="It's ok to have a bad day" />
-</p>
+</div>
diff --git a/docs/images/.gitkeep b/docs/images/.gitkeep
diff --git a/package.json b/package.json
@@ -1,19 +1,9 @@
 {
-  "metadata": {
-    "publisher": "Pursuit",
-    "languages": [
-      "PureScript"
-    ],
-    "frameworks": [],
-    "paradigms": [
-      "Functional"
-    ],
-    "lifecycle": "Pre-alpha"
-  },
+  "packageManager": "yarn@4.1.1",
   "scripts": {
-    "prepare": "husky install",
+    "postinstall": "husky",
     "format": "prettier . --write && echo src test | xargs -n1 npx purty --write",
-    "lint": "cspell . --dot && eslint . --fix --no-error-on-unmatched-pattern"
+    "lint": "cspell . --dot --gitignore && eslint . --fix --no-error-on-unmatched-pattern && trufflehog3"
   },
   "resolutions": {
     "string-width": "4.2.3",
diff --git a/spago.lock b/spago.lock
diff --git a/spago.yaml b/spago.yaml
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`	`1`	`npm run lint`
`2`		`-spago test`
	`2`	`+yarn spago test`