Initial commit

Author: jamesdabbs

.eslintrc.js

@@ -0,0 +1 @@
+module.exports = require('./src/eslint')

.github/workflows/codeql.yml

@@ -0,0 +1,26 @@
+name: CodeQL
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+  schedule:
+    - cron: "16 23 * * 2"
+
+jobs:
+  analyze:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v1
+        with:
+          languages: javascript
+      - name: Autobuild
+        uses: github/codeql-action/autobuild@v1
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v1

.github/workflows/release.yml

@@ -0,0 +1,18 @@
+name: Release
+
+on:
+  release:
+    types:
+      - created
+
+jobs:
+  publish:
+    name: Publish
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: bahmutov/npm-install@v1
+      - run: npm run build
+      - run: npm publish
+        env:
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/test.yml

@@ -0,0 +1,43 @@
+name: Test
+on:
+  push:
+    branches:
+      - "*"
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - uses: bahmutov/npm-install@v1
+      - name: Lint
+        run: npm run lint:check
+      - name: Formatting
+        run: npm run fmt:check
+
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - uses: bahmutov/npm-install@v1
+      - name: Test
+        run: npm run test:cov
+      - name: Report coverage
+        uses: codecov/codecov-action@v1
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          file: ./coverage/lcov.info
+          fail_ci_if_error: true
+
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - uses: bahmutov/npm-install@v1
+      - name: Build
+        run: npm run build
+      - name: Build
+        run: npm run build:declarations

.gitignore

@@ -0,0 +1,4 @@
+.eslintcache
+coverage/
+dist/
+node_modules/

.vscode/extensions.json

@@ -0,0 +1,6 @@
+{
+  "recommendations": [
+    "dbaeumer.vscode-eslint",
+    "eg2.vscode-npm-script"
+  ]
+}

README.md

@@ -0,0 +1,31 @@
+<h2 align="center">π-Base Core</h2>
+<div align="center">
+
+[![Test](https://github.com/pi-base/core/workflows/Test/badge.svg?branch=main)](https://github.com/pi-base/core/actions/workflows/test.yml)
+[![codecov](https://codecov.io/gh/pi-base/core/branch/main/graph/badge.svg?token=7JO1N1OXJB)](https://codecov.io/gh/pi-base/core)
+
+<!-- TODO: [![Release](https://github.com/pi-base/core/workflows/Release/badge.svg?branch=main)](https://github.com/pi-base/code/actions/workflows/release.yml) -->
+<!-- TODO: npm badge -->
+
+<div align="center">
+
+Shared data model for the [π-Base viewer](https://github.com/pi-base/viewer) and associated utilities.
+
+## Local Development
+
+Clone the repo and then run
+
+```bash
+$ npm install
+$ npm run test
+```
+
+See the [viewer](https://github.com/pi-base/viewer) and [compiler](https://github.com/pi-base/compile) for examples of usage. This package is mostly internal implementation details, and tends to be fluid and sparsely documented. If you are interested in building on top of this package, please reach out so we can better support you.
+
+# Releasing
+
+```bash
+$ npm run build
+$ npm run test
+$ npm publish
+```

bin/build

@@ -0,0 +1,45 @@
+#! node
+
+const esbuild = require('esbuild')
+
+function report(error, { warnings }) {
+  if (error) {
+    console.error('Build error', error)
+  } else if (warnings.length > 0) {
+    console.warn('Build succeeded with errors', result)
+  } else {
+    console.log('Build succeeded')
+  }
+}
+
+const watch = process.argv.includes('--watch')
+
+const builds = [
+  esbuild.build({
+    entryPoints: ['src/index.ts'],
+    bundle: true,
+    outfile: 'dist/main.js',
+    platform: 'node',
+    watch: watch ? { onRebuild: report } : false
+  }),
+  esbuild.build({
+    entryPoints: ['src/cli.ts'],
+    bundle: true,
+    outfile: 'dist/cli.js',
+    platform: 'node',
+    watch: watch ? { onRebuild: report } : false
+  }),
+]
+
+Promise.all(builds).then(results => {
+  if (watch) {
+    console.log('Watching for changes')
+  } else {
+    for (const result of results) {
+      report(result)
+    }
+  }
+}).catch(error => {
+  console.error(error)
+  process.exit(1)
+})

jest.config.js

@@ -0,0 +1,20 @@
+module.exports = {
+  bail: 10,
+  clearMocks: true,
+  coverageDirectory: 'coverage',
+  coveragePathIgnorePatterns: ['/node_modules/'],
+  coverageProvider: 'v8',
+  errorOnDeprecated: true,
+  moduleFileExtensions: ['js', 'ts'],
+  notify: true,
+  notifyMode: 'failure-change',
+  resetMocks: true,
+  roots: ['src'],
+  testEnvironment: 'node',
+  testMatch: ['**/*.test.ts'],
+  testRunner: 'jest-circus/runner',
+  transform: {
+    '^.+\\.ts$': 'ts-jest',
+  },
+  verbose: true,
+}