feat!: refactor into monorepo with compile and cli packages

.github/workflows/build.yaml

@@ -48,7 +48,6 @@ jobs:
         run: |
           pnpm install
 
-      - name: Run tests
+      - name: Build and test
         run: |
-          pnpm prettier:check
-          pnpm test
+          ./scripts/ci-build

.github/workflows/release.yaml

@@ -61,11 +61,9 @@ jobs:
         run: |
           pnpm install
 
-      - name: Build
-        id: build
+      - name: Build and test
         run: |
-          pnpm prettier:check
-          pnpm test
+          ./scripts/ci-build
 
       # Save the npmjs auth token so that the workflow can publish packages to the registry
       - name: Configure npm auth token

.prettierignore

@@ -1,4 +1 @@
-src/web
-.vscode
-CHANGELOG.md
 pnpm-lock.yaml

.release-please-manifest.json

@@ -1,3 +1,4 @@
 {
-  ".": "0.6.0"
+  "packages/compile": "0.6.0",
+  "packages/cli": "0.6.0"
 }

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016-19 Todd Fincannon and Climate Interactive/New Venture Fund
+Copyright (c) 2016-2022 Todd Fincannon and Climate Interactive / New Venture Fund
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -82,15 +82,15 @@ If you want to use the stable release of SDEverywhere, simply install the npm pa
 **Install the stable release version of SDEverywhere**
 
 ```
-npm install sdeverywhere -g
+npm install @sdeverywhere/cli -g
 ```
 
 **Install the development version of SDEverywhere**
 
 If you previously installed the SDEverywhere package using npm, uninstall that package first before installing your new, local copy.
 
 ```
-npm rm sdeverywhere -g
+npm rm @sdeverywhere/cli -g
 ```
 
 Clone the `SDEverywhere` and `antlr4-vensim` repos in a project directory of your choice using either `git` on the command line or Sourcetree (see below).
@@ -287,17 +287,6 @@ sde test {model}
 sde clean {model}
 ```
 
-**Generate a web app to run the model and graph the results**
-
-Note that the `generate --genhtml` command currently uses [Browserify](http://browserify.org)
-to bundle the web app. The `browserify` package is not included with SDEverywhere by
-default, so you will need to install it first as a dev dependency.
-
-```
-npm install --save-dev browserify
-sde generate --genhtml {model}
-```
-
 **Print variable dependencies**
 
 ```
@@ -406,7 +395,7 @@ SDEverywhere covers a subset of the Vensim modeling language used in models that
 
 If you are using Atom, you can run the Chrome debugger inside Atom using the [Atom IDE](https://ide.atom.io/).
 
-To run in the Chrome debugger, start Node with the `--inspect-brk` flag. Use `node sde.js` from the SDEverywhere `src` directory.
+To run in the Chrome debugger, start Node with the `--inspect-brk` flag. Use `node main.js` from the `packages/cli/src` directory.
 
 [Debugging Node.js with Chrome DevTools](https://medium.com/@paul_irish/debugging-node-js-nightlies-with-chrome-devtools-7c4a1b95ae27)
 
@@ -442,7 +431,7 @@ The `Variable` class is the heart of SDEverywhere. An equation has a left-hand s
 
 ### Parsing
 
-The `sdegen` command reads the model file, an optional model spec JSON file detailing input and output variables, and an optional subscript JSON file detailing dimensions, indices, and mappings. Each file is parsed and then handed off to the `CodeGen` object.
+The `sde generate` command reads the model file, an optional model spec JSON file detailing input and output variables, and an optional subscript JSON file detailing dimensions, indices, and mappings. Each file is parsed and then handed off to the `CodeGen` object.
 
 The model file is parsed using a grammar generated by [ANTLR 4](http://www.antlr.org/). The parser constructs a parse tree that the code generator works with. The model file is passed through a preprocessor first to handle some things the grammar can't work with yet, such as macros and tabbed arrays. See the [antlr4-vensim](https://github.com/climateinteractive/antlr4-vensim) package for more on the parser.
 

models/comments/comments_check.sh

@@ -1,7 +1,7 @@
 #!/bin/bash
 
 MODEL_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
-SDE='node ../../src/sde.js'
+SDE='node ../../packages/cli/src/main.js'
 
 cd $MODEL_DIR
 $SDE generate --preprocess comments.mdl

models/flatten/flatten_check.sh

@@ -1,7 +1,7 @@
 #!/bin/bash
 
 MODEL_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
-SDE='node ../../src/sde.js'
+SDE='node ../../packages/cli/src/main.js'
 
 cd $MODEL_DIR
 $SDE flatten output.mdl --inputs input1.mdl input2.mdl

models/preprocess/preprocess_check.sh

@@ -1,7 +1,7 @@
 #!/bin/bash
 
 MODEL_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
-SDE='node ../../src/sde.js'
+SDE='node ../../packages/cli/src/main.js'
 
 cd $MODEL_DIR
 $SDE generate --preprocess input.mdl

package.json

@@ -1,46 +1,30 @@
 {
-  "name": "sdeverywhere",
-  "version": "0.6.0",
+  "name": "sdeverywhere-monorepo",
+  "private": true,
   "description": "SDEverywhere translates System Dynamics models from Vensim to C and WebAssembly",
   "type": "module",
-  "files": [
-    "src/**",
-    "!.DS_Store"
-  ],
-  "bin": {
-    "sde": "src/index.js"
-  },
   "scripts": {
-    "prettier:check": "prettier --check .",
-    "prettier:fix": "prettier --write .",
-    "test": "cd src/tests && ./modeltests"
-  },
-  "dependencies": {
-    "antlr4": "4.9.2",
-    "antlr4-vensim": "0.6.0",
-    "bufx": "^1.0.5",
-    "byline": "^5.0.0",
-    "chart.js": "^2.9.4",
-    "csv-parse": "^4.15.4",
-    "digraph-sort": "^0.2.1",
-    "fs-extra": "^9.0.0",
-    "he": "^1.2.0",
-    "js-yaml": "^3.13.1",
-    "minimist": "^1.2.5",
-    "numbro": "1.11.1",
-    "ramda": "^0.27.0",
-    "shelljs": "^0.8.3",
-    "split-string": "^6.0.0",
-    "xlsx": "^0.17.0",
-    "yargs": "^17.2.1"
+    "clean": "pnpm -r clean",
+    "lint-pkgs": "pnpm -r lint",
+    "lint": "pnpm lint-pkgs",
+    "prettier-local:check": "prettier --check \"./*.{js,json,md,yaml}\"",
+    "prettier-local:fix": "prettier --write \"./*.{js,json,md,yaml}\"",
+    "prettier-pkgs:check": "pnpm -r prettier:check",
+    "prettier-pkgs:fix": "pnpm -r prettier:fix",
+    "prettier:check": "run-s prettier-local:check prettier-pkgs:check",
+    "prettier:fix": "run-s prettier-local:fix prettier-pkgs:fix",
+    "precommit": "pnpm -r precommit",
+    "build": "pnpm run -r --workspace-concurrency=1 build",
+    "test:e2e": "./tests/modeltests",
+    "test": "run-s test:e2e"
   },
   "devDependencies": {
-    "prettier": "^2.3.2"
+    "npm-run-all": "^4.1.5",
+    "prettier": "^2.6.2"
   },
   "author": "Climate Interactive",
   "license": "MIT",
   "homepage": "https://sdeverywhere.org",
-  "readmeFilename": "README.md",
   "repository": {
     "type": "git",
     "url": "https://github.com/climateinteractive/SDEverywhere.git"

packages/cli/.prettierignore

@@ -0,0 +1 @@
+CHANGELOG.md

packages/cli/README.md

@@ -0,0 +1,14 @@
+# @sdeverywhere/cli
+
+This package contains the `sde` command line interface for the SDEverywhere
+suite of tools.
+
+SDEverywhere can be used to translate System Dynamics models from Vensim to C and WebAssembly.
+
+## Documentation
+
+TODO
+
+## License
+
+SDEverywhere is distributed under the MIT license. See `LICENSE` for more details.

packages/cli/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@sdeverywhere/cli",
+  "version": "0.7.0",
+  "description": "Contains the `sde` command line interface for the SDEverywhere tool suite.",
+  "type": "module",
+  "files": [
+    "src/**",
+    "!.DS_Store"
+  ],
+  "bin": {
+    "sde": "src/main.js"
+  },
+  "scripts": {
+    "lint": "echo No lint step yet",
+    "prettier:check": "prettier --check .",
+    "prettier:fix": "prettier --write .",
+    "precommit": "../../scripts/precommit",
+    "ci:build": "run-s lint prettier:check"
+  },
+  "dependencies": {
+    "@sdeverywhere/compile": "^0.7.0",
+    "bufx": "^1.0.5",
+    "byline": "^5.0.0",
+    "fs-extra": "^10.1.0",
+    "ramda": "^0.27.0",
+    "shelljs": "^0.8.3",
+    "yargs": "^17.5.1"
+  },
+  "author": "Climate Interactive",
+  "license": "MIT",
+  "homepage": "https://sdeverywhere.org",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/climateinteractive/SDEverywhere.git",
+    "directory": "packages/cli"
+  },
+  "bugs": {
+    "url": "https://github.com/climateinteractive/SDEverywhere/issues"
+  }
+}