Code Review PR for Initial Commit

.editorconfig

@@ -0,0 +1 @@
+indent_size = 2

.eslintignore

@@ -0,0 +1,3 @@
+dist/
+lib/
+node_modules/

.eslintrc.js

@@ -0,0 +1,26 @@
+module.exports = {
+  plugins: ['jest', '@typescript-eslint'],
+  extends: ['plugin:jest/all'],
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    ecmaVersion: 9,
+    sourceType: 'module',
+  },
+  rules: {
+    'eslint-comments/no-use': 'off',
+    'import/no-namespace': 'off',
+    'no-unused-vars': 'off',
+    'no-console': 'off',
+    'jest/prefer-expect-assertions': 'off',
+    'jest/no-disabled-tests': 'warn',
+    'jest/no-focused-tests': 'error',
+    'jest/no-identical-title': 'error',
+    'jest/prefer-to-have-length': 'warn',
+    'jest/valid-expect': 'error',
+  },
+  env: {
+    node: true,
+    es6: true,
+    'jest/globals': true,
+  },
+};

.github/workflows/tests.yml

@@ -0,0 +1,34 @@
+name: Tests
+on:
+  pull_request:
+    paths-ignore:
+      - '**.md'
+  push:
+    branches:
+      - master
+    paths-ignore:
+      - '**.md'
+jobs:
+  test:
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macOS-latest]
+    name: Test on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+
+    steps:
+    - uses: actions/checkout@v1
+    - uses: actions/setup-node@v1
+      with:
+        node-version: '12.x'
+    - name: Install dependencies
+      run: npm ci
+    - name: Run prettier format check
+      run: npm run format-check
+    - name: Build
+      run: npm run build
+    - name: Run tests
+      run: npm run test
+    - name: Upload code coverage
+      run: |
+        bash <(curl -s https://codecov.io/bash)

.gitignore

@@ -4,4 +4,3 @@ node_modules
 
 !dist
 !dist/cache
-

.prettierignore

@@ -0,0 +1,3 @@
+dist/
+lib/
+node_modules/

.prettierrc.json

@@ -0,0 +1,11 @@
+{
+  "printWidth": 80,
+  "tabWidth": 2,
+  "useTabs": false,
+  "semi": true,
+  "singleQuote": true,
+  "trailingComma": "all",
+  "bracketSpacing": true,
+  "arrowParens": "avoid",
+  "parser": "typescript"
+}

LICENSE

@@ -0,0 +1,22 @@
+
+The MIT License (MIT)
+
+Copyright (c) 2018 GitHub, Inc. and contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -0,0 +1,212 @@
+# cached-dependencies
+
+[![](https://github.com/ktmud/cached-dependencies/workflows/Tests/badge.svg)](https://github.com/ktmud/cached-dependencies/actions?query=workflow%3ATests) [![codecov](https://codecov.io/gh/ktmud/cached-dependencies/branch/master/graph/badge.svg)](https://codecov.io/gh/ktmud/cached-dependencies)
+
+Enable **multi-layer cache** and **shortcut commands** in any workflows.
+
+Manage multiple cache targets in one step. Use either the built-in cache configs for npm, yarn, and pip, or write your own. Create a bash command library to easily reduce redudencies across workflows. Most useful for building webapps that require multi-stage building processes.
+
+This is your all-in-one action for everything related to setting up dependencies with cache.
+
+## Inputs
+
+- **run**: bash commands to run, allows shortcut commands
+- **caches**: path to a JS module that defines cache targets, defaults to `.github/workflows/caches.js`
+- **bashlib**: path to a BASH scripts that defines shortcut commands, defaults to `.github/workflows/bashlib.sh`
+- **parallel**: whether to run the commands in parallel with node subprocesses
+
+## Examples
+
+Following workflow sets up dependencies for a typical Python web app with both `~/.pip` and `~/.npm` cache configured in one simple step:
+
+```yaml
+jobs:
+  build_and_test:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v2
+    - name: Install dependencies
+      uses: ktmud/cached-dependencies@v1
+      with:
+        run: |
+          npm-install
+          npm run build
+
+          pip-install
+          python ./bin/manager.py fill_test_data
+```
+
+Here we used predefined `npm-install` and `pip-install` commands to install dependencies with correponding caches.
+
+You may also replace `npm-install` with `yarn-install` to install npm pacakges with `yarn.lock`.
+
+```yaml
+- name: Install dependencies
+  uses: ktmud/cached-dependencies@v1
+  with:
+    run: |
+      yarn-install
+      yarn build
+
+      pip-install
+      python ./bin/manager.py fill_test_data
+```
+
+See below for more details.
+
+## Usage
+
+### Cache configs
+
+Under the hood, we use [@actions/cache](https://github.com/marketplace/actions/cache) to manage cache storage. But instead of defining only one cache at a time and specify them in workflow YAMLs, you manage all caches in a spearate JS file: `.github/workflows/caches.js`.
+
+Here is [the default configuration](https://github.com/ktmud/cached-dependencies/blob/master/src/cache/caches.ts) for Linux:
+
+```js
+module.exports = {
+  pip: {
+    path: [`${process.env.HOME}/.cache/pip`],
+    hashFiles: ['requirements*.txt'],
+    keyPrefix: 'pip-',
+    restoreKeys: 'pip-',
+  },
+  npm: {
+    path: [`${HOME}/.npm`],
+    hashFiles: [
+      `package-lock.json`,
+      `*/*/package-lock.json`,
+      `!node_modules/*/package-lock.json`,
+    ],
+  },
+  yarn: {
+    path: [`${HOME}/.npm`],
+   // */* is for supporting lerna monorepo with depth=2
+    hashFiles: [`yarn.lock`, `*/*/yarn.lock`, `!node_modules/*/yarn.lock`],
+  },
+}
+```
+
+In which `hashFiles` and `keyPrefix` will be used to compute the primary cache key used in [@actions/cache](https://github.com/marketplace/actions/cache). `keyPrefix` will default to `${cacheName}-` and `restoreKeys` will default to `keyPrefix` if not specified.
+
+It is recommended to always use absolute paths in these configs so you can share them across different worflows more easily (in case you the action is called from different working directories).
+
+#### Speficy when to restore and save
+
+With the predefined `cache-store` and `cache-save` bash commands, you have full flexibility on when to restore and save cache:
+
+```yaml
+steps:
+- uses: actions/checkout@v2
+- uses: ktmud/cached-dependencies@v1
+  with:
+    run: |
+      cache-restore npm
+      npm install
+      cache-save npm
+
+      cache-restore pip
+      pip install -r requirements.txt
+      cache-save pip
+```
+
+### Shortcut commands
+
+All predefined shortcut commands can be found [here](https://github.com/ktmud/cached-dependencies/blob/master/src/scripts/bashlib.sh). You can also customize them or add new ones in `.github/workflows/bashlib.sh`.
+
+For example, if you want to install additional packages for before saving `pip` cache, simply add this to the `bashlib.sh` file:
+
+```bash
+# override the default `pip-install` command
+pip-install() {
+  cd $GITHUB_WORKSPACE
+
+  cache-restore pip
+
+  echo "::group::pip install"
+  pip install -r requirements.txt      # prod requirements
+  pip install -r requirements-dev.txt  # dev requirements
+  pip install -e ".[postgres,mysql]"   # current pacakge with some extras
+  echo "::endgroup::"
+
+  cache-save pip
+}
+```
+
+### Default setup command
+
+When `run` is not provided:
+
+```yaml
+jobs:
+  name: Build
+  steps:
+    - name: Install dependencies
+      uses: ktmud/cached-depdencies@v1
+```
+
+You must provide a `default-setup-command` in the bashlib. For example,
+
+```bash
+default-setup-command() {
+  pip-install & npm-install
+}
+```
+
+This will start installing pip and npm dependencies at the same time.
+
+### Customize config locations
+
+Both the two config files, `.github/workflows/bashlib.sh` and `.github/workflows/caches.js`, can be placed in other locations:
+
+```yaml
+- uses: ktmud/cached-dependencies@v1
+  with:
+    caches: ${{ github.workspace }}/.github/configs/caches.js
+    bashlib: ${{ github.workspace }}/.github/configs/bashlib.sh
+```
+
+### Run commands in parallel
+
+When `parallel` is set to `true`, the `run` input will be split into an array of commands and passed to `Promise.all(...)` to execute in parallel. For example,
+
+```yaml
+- uses: ktmud/cached-dependencies@v1
+  with:
+    parallel: true
+    run: |
+      pip-install
+      npm-install
+```
+
+is equivalent to
+
+```yaml
+- uses: ktmud/cached-dependencies@v1
+  with:
+    run: |
+      pip-install & npm-install
+```
+
+If one or more of your commands must spread across multiple lines, you can add a new line between the parallel commands. Each command within a parallel group will still run sequentially.
+
+```yaml
+- uses: ktmud/cached-dependencies@v1
+  with:
+    run: |
+      cache-restore pip
+      pip install requirements*.txt
+      # additional pip packages
+      pip install package1 package2 pacakge2
+      cache-save pip
+
+      npm-install
+
+      cache-restore cypress
+      cd cypress/ && npm install
+      cache-save cypress
+```
+
+## License
+
+This project is released under [the MIT License](LICENSE).