feat: use lerna hoisting for fast monorepo bootstrapping

.eslintrc.js

@@ -2,8 +2,8 @@ module.exports = {
   root: true,
   parser: '@typescript-eslint/parser',
   reportUnusedDisableDirectives: true,
-  extends: '@stacks/eslint-config',
-  plugins: ['@typescript-eslint', 'node'],
+  extends: ['@stacks/eslint-config', 'plugin:import/typescript'],
+  plugins: ['@typescript-eslint', 'node', 'import'],
   parserOptions: {
     tsconfigRootDir: __dirname,
     project: ['./packages/**/tsconfig.json', './tsconfig.json'],
@@ -29,5 +29,7 @@ module.exports = {
     '@typescript-eslint/no-non-null-assertion': [0],
 
     'node/prefer-global/buffer': ['error', 'never'],
+
+    'import/no-extraneous-dependencies': ['error'],
   },
 };

.github/workflows/stacks-js.yml

@@ -2,8 +2,6 @@ name: stacks.js
 
 on:
   push:
-    branches:
-      - 'master'
   pull_request:
 
 jobs:

README.md

@@ -20,7 +20,7 @@ See `README` in each package directory for installation instructions and usage.
 
 To migrate your app from blockstack.js to stacks.js follow the steps in the [migration guide](https://github.com/blockstack/stacks.js/tree/master/migration-guide.md).
 
-## Development environment setup
+## Development: environment setup
 
 To setup the development environment for this repository, follow these steps:
 
@@ -30,6 +30,23 @@ To setup the development environment for this repository, follow these steps:
 4. Run `npm run build` to build packages
 5. Run `npm run test` to run tests
 
+## Development: adding dependencies
+
+This repo uses Lerna [hoisting](https://github.com/lerna/lerna/blob/main/doc/hoist.md) for package dependencies.
+
+In order to install a new dependency to a package, the [`lerna add`](https://github.com/lerna/lerna/tree/main/commands/add) command must be used, rather than `npm install <package>`.
+
+For example, the following command installs `lodash` as a dependency to the `@stacks/storage` package:
+```shell
+# Run within the root directory
+npm run lerna -- add lodash --scope @stacks/storage
+```
+
+Add `--dev` to install as a development dependency:
+```shell
+npm run lerna -- add lodash --scope @stacks/storage --dev
+```
+
 ## Documentation
 
 Documentation for Stacks tooling is located [here](https://docs.blockstack.org/).

lerna.json

@@ -6,5 +6,12 @@
   },
   "packages": [
     "packages/*"
-  ]
+  ],
+  "command": {
+    "bootstrap": {
+      "forceLocal": true,
+      "hoist": true,
+      "npmClientArgs": ["--ci"]
+    }
+  }
 }