4.0 build system (#911)

* 4.0 build system WIP

* working build system

* wip

* co

* add fetch package

* wip

* remove typedoc

* more cleanup

* remove package locks

* restore typedoc

* continue cleanup

* remove old ts-helper for node tests

* remove old ts-helper for node tests

* update engine

* delete lerna.json

* continue cleanup

* Use node-fetch 3.0, fix rollup

* updates to webpack and rollup, add files

* Update demos/node-common-js/package.json

Co-authored-by: Noah Mulfinger <[email protected]>

* Update package-lock.json

* rollup support

* more rollup fixing

* clean up

* revert linting

* rollup specific builds

* add wrapper around node-fetch

* More WIP

* chrome debugging

* cleanup skypack check, fix intermittantly failing test

* migrate @esri/arcgis-rest-auth, fix browser auth test

* auth demo

* migrate portal, service admin and routing

* migrate all packages

* cleanup package.jsons

* attachments demo

* more demo work

* fix spelling of Vernonia

* wrap up demos

* more demos

* use import/export type, ultra runner, better rollup

* format package.jsons

* update actions

* fix build script

* fix tests, add file attachment node demo, remove data for file/text in tests

* use npm 7 in GitHub actions

* fix build

* upgrade npm in actions

* fix tests

* don't fail fast on tests

* don't fail fast on tests

* sass

* fix tests

* deno demo, cleanup

* final cleanup

* fix tests in windows, cleanup test deprecations

Co-authored-by: Noah Mulfinger <[email protected]>

Author: patrickarlt

.eslintrc.js

@@ -0,0 +1,37 @@
+{
+  "root": true,
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "ecmaVersion": 2018,
+    "sourceType": "module"
+  },
+  "env": {
+    "browser": true,
+    "node": true,
+    "es2017": true
+  },
+  "plugins": ["@typescript-eslint", "import"],
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended",
+    "prettier",
+    "prettier/@typescript-eslint",
+    "plugin:import/recommended",
+    "plugin:import/typescript"
+  ],
+  "rules": {
+    "@typescript-eslint/no-explicit-any": "off",
+    "@typescript-eslint/no-unused-vars": "off",
+    "@typescript-eslint/ban-types": "off",
+    "@typescript-eslint/explicit-module-boundary-types": "off",
+    "import/extensions": ["error", "ignorePackages"],
+
+    // remove import/no-unresolved once https://github.com/import-js/eslint-plugin-import/issues/2111 is resolved
+    "import/no-unresolved": "off"
+  },
+  "settings": {
+    "import/parsers": {
+      "@typescript-eslint/parser": [".ts", ".tsx"]
+    }
+  }
+}

.eslintrc.json

@@ -15,16 +15,20 @@ jobs:
     runs-on: ${{ matrix.os }}
 
     strategy:
+      fail-fast: false
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
-        node: [12, 14]
+        node: [12, 14, 16]
 
     steps:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v2
         with:
           node-version: ${{ matrix.node }}
 
+      - name: Upgrade npm
+        run: npm i -g npm@7
+
       - name: Install Dependencies
         run: npm install
 

.github/workflows/pre-release-tests.yml

@@ -15,16 +15,20 @@ jobs:
     runs-on: ${{ matrix.os }}
 
     strategy:
+      fail-fast: false
       matrix:
         os: [ubuntu-latest]
-        node: [14]
+        node: [12, 14, 16]
 
     steps:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v2
         with:
           node-version: ${{ matrix.node }}
 
+      - name: Update to NPM 7 for workspace support
+        run: npm install -g npm@7
+
       - name: Install Dependencies
         run: npm install
 

.github/workflows/pull-request-tests.yml

@@ -98,4 +98,13 @@ packages/**/test/mocks/**/*.js
 packages/**/test/mocks/**/*.map
 
 # Ignore built TypeDoc files
-typedoc
+typedoc
+
+# Ignore srihash output
+srihashes.json
+
+# Prevent caches from ultra runner
+**/.ultra.cache.json
+
+# Prevent package locks from npm installs in demos
+demos/*/package-lock.json

.gitignore

@@ -13,7 +13,7 @@
   "semi": true,
   "singleQuote": false,
   "tabWidth": 2,
-  "trailingComma": "es5",
+  "trailingComma": "none",
   "useTabs": false,
   "vueIndentScriptAndStyle": false
 }

.prettierrc

@@ -5,20 +5,21 @@
   "version": "0.2.0",
   "configurations": [
     {
+      "name": "Attach to `npm run test:node:debug`",
       "type": "node",
-      "request": "launch",
-      "name": "Debug Node Tests",
-      "program": "${workspaceRoot}/node_modules/.bin/jasmine",
-      "args": [
-        "--config=jasmine.json"
-      ]
+      "request": "attach",
+      "port": 9229
     },
     {
-      "type": "node",
-      "request": "launch",
-      "name": "Debug Changelog Script",
-      "program": "${workspaceRoot}/support/changelog.js",
-      "args": ["--config=jasmine.json"]
+      "type": "pwa-msedge",
+      "request": "attach",
+      "name": "Attach to `npm run test:chrome:debug`",
+      "address": "localhost",
+      "port": 9333,
+      "pathMapping": {
+        "/": "${workspaceRoot}/",
+        "/base/": "${workspaceRoot}/"
+      }
     }
   ]
 }

.vscode/launch.json

@@ -1,3 +1,5 @@
 {
-    "editor.tabSize": 2
+    "editor.tabSize": 2,
+    "javascript.preferences.importModuleSpecifierEnding": "js",
+    "typescript.preferences.importModuleSpecifierEnding": "js"
 }

.vscode/settings.json

@@ -48,26 +48,34 @@ The documentation is published at http://esri.github.io/arcgis-rest-js/ (source
 
 ### Instructions
 
-You can install dependencies (and bootstrap lerna) by cloning the repository and running:
+You can install dependencies by cloning the repository and running:
 
 ```bash
 npm install
 ```
 
 Afterward, for a list of all available commands run `npm run`.
 
-Some useful commands include:
+For all packages
 
-- `npm test` runs _all_ the tests and confirms the API is functioning as expected.
-- There is also a `Debug Node Tests` configuration in the `.vscode/launch.json` which will run the Node tests in the VS Code debugger.
-- `npm run docs:serve` will run the documentation site locally at http://localhost:3000/arcgis-rest-js/
-- `npm run build` will created UMD bundles for _all_ the packages
-- `npm run dev -- <esm|node|umd> <glob>` will re-run the specified build type anytime the source code changes. Example: `npm run dev -- umd @esri/*`
+- `npm run build` - builds all distributions of every package with `ultra`, inside each package builds are done in parallel with `npm-run-all`. Output is errors only.
+- `npm run build:esm`, `npm run build:cjs`, `npm run build:bundled` - as as the above but only one of our target distributions.
+- `npm run dev:esm`, `npm run dev:cjs`, `npm run dev:bundled` - runs the appropriate watch command in all packages.
+
+For a specific package
+
+- `npm run build -w @esri/arcgis-rest-request` - run all builds in a specific workspace
+- `npm run dev -w @esri/arcgis-rest-request` - run all dev commands in a specific workspace
+- `npm run build:esm -w @esri/arcgis-rest-request` - run the esm build in a specific workspace
+- `npm run dev:esm -w @esri/arcgis-rest-request` - run the esm dev command in a specific workspace
+- `npm run build:cjs -w @esri/arcgis-rest-request` - run the common js build in a specific workspace
+- `npm run dev:cjs -w @esri/arcgis-rest-request` - run the common js dev command in a specific workspace
+- `npm run build:bundled -w @esri/arcgis-rest-request` - run the rollup build in a specific workspace
+- `npm run dev:bundled -w @esri/arcgis-rest-request` - run the rollup dev command in a specific workspace
 
 ### Packages
 
 - [`@esri/arcgis-rest-request`](./packages/arcgis-rest-request/) - Underpins other packages and supports making low-level requests.
-- [`@esri/arcgis-rest-auth`](./packages/arcgis-rest-auth) - Provides methods for authenticating named users and applications.
 - [`@esri/arcgis-rest-portal`](./packages/arcgis-rest-portal) - Methods for working with ArcGIS Online/Enterprise content and users.
 - [`@esri/arcgis-rest-feature-layer`](./packages/arcgis-rest-feature-layer) - Functions for querying and editing features inside of hosted feature layers.
 - [`@esri/arcgis-rest-service-admin`](./packages/arcgis-rest-service-admin) - Functions for administering hosted feature services.

README.md

@@ -8,9 +8,10 @@ This project uses the `commander` module, which streamlines the creation of node
 
 ### Installing
 
-Like all the other demo apps, run `npm run bootstrap` from the root.
+Like all the other demo apps, run `npm run build` from the root.
 
 ### Running
+
 If you use this demo as a starting point for your own command line package, you would publish it to npm, then on the target systems run `npm install <your-cli-package>`, and it would be available as a command.
 
 But, this is demo code, and thus the package is not "installed" via `npm install ...`, before we can call it as `ago <command> <query>` we need to run `npm link` in the `/demos/ago-node-cli` folder. After you do that, the command should work.
@@ -19,9 +20,9 @@ Here is a post with information on creating node command line tools: [A Guide to
 
 ### Commands
 
-| command | description | example |
-| --- | --- | --- |
-| `ago search <query>` | search for items | `ago search water` |
+| command                  | description                   | example                                               |
+| ------------------------ | ----------------------------- | ----------------------------------------------------- |
+| `ago search <query>`     | search for items              | `ago search water`                                    |
 | `ago export <id> <file>` | export an item to a json file | `ago export a62cb9d894f145cc89531c096d0012b1 pa.json` |
 
 ## Building your own tooling

demos/ago-node-cli/README.md

@@ -1,33 +1,31 @@
 #!/usr/bin/env node
-require('cross-fetch/polyfill');
-require('isomorphic-form-data');
 
 /**
  * This demo uses the commander module, which streamlines the creation of command-line-applications
  */
-const program = require('commander');
+const program = require("commander");
 
-program
-  .version('0.0.1');
+program.version("0.0.1");
 
 /**
  * Bring in the search command...
  */
-const itemSearchCommand = require('./lib/item-search-command');
+const itemSearchCommand = require("./lib/item-search-command");
 
 program
-  .command('search <query>')
-  .description('Search for items')
+  .command("search <query>")
+  .description("Search for items")
   .action(function (query) {
+    console.log(query);
     itemSearchCommand.execute(query);
   });
 
-  const itemExportCommand = require('./lib/item-export-command');
-  program
-  .command('export <itemId> <filename>')
-  .description('Export an item to a json file')
+const itemExportCommand = require("./lib/item-export-command");
+program
+  .command("export <itemId> <filename>")
+  .description("Export an item to a json file")
   .action(function (id, filename) {
     itemExportCommand.execute(id, filename);
   });
 
-program.parse(process.argv);
+program.parse(process.argv);

demos/ago-node-cli/ago.js

@@ -1,4 +1,3 @@
-
 /**
  * Bring in searchItems fn
  */
@@ -11,25 +10,23 @@ module.exports = {
   execute: function (query) {
     // construct the search call..
     return searchItems({
-      searchForm: {
-        q: query,
-        start: 1,
-        num: 10
-      }
-    })
-    .then((response) => {
-      // if we got results
-      if (Array.isArray(response.results) && response.results.length)  {
-        console.info(`${response.total} items found for "${query}".`);
-        response.results.forEach((entry) => {
-          console.info(`${entry.id} | ${entry.title}`);
-        })
-      } else {
-        console.info(`No results found for "${query}".`);
-      }
+      q: query,
+      start: 1,
+      num: 10
     })
-    .catch((err) => {
-      console.error(err);
-    });
+      .then((response) => {
+        // if we got results
+        if (Array.isArray(response.results) && response.results.length) {
+          console.info(`${response.total} items found for "${query}".`);
+          response.results.forEach((entry) => {
+            console.info(`${entry.id} | ${entry.title}`);
+          });
+        } else {
+          console.info(`No results found for "${query}".`);
+        }
+      })
+      .catch((err) => {
+        console.error(err);
+      });
   }
-}
+};