Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sunesimonsen/workspace-cache
A workspace cache for Yarn workspaces and Lerna
https://github.com/sunesimonsen/workspace-cache
Last synced: 1 day ago
JSON representation
A workspace cache for Yarn workspaces and Lerna
- Host: GitHub
- URL: https://github.com/sunesimonsen/workspace-cache
- Owner: sunesimonsen
- License: mit
- Created: 2020-03-21T19:57:20.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-06-17T10:31:56.000Z (4 months ago)
- Last Synced: 2024-06-17T11:57:02.564Z (4 months ago)
- Language: JavaScript
- Size: 149 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## workspace-cache
[](https://travis-ci.org/sunesimonsen/workspace-cache)
A command line utility to manage a workspace cache for Yarn workspaces or Lerna.
It will allow you to cache build artifacts based for each packages in a
workspace and retrieve the cached artifacts. It understands the local
dependencies between packages and can figure out which packages has changed
based on the individual files in each package.
## Installation
```sh
npm install workspace-cache
```
## Usage
```
Usage
$ workspace-cache [flags]
Flags
--concurrency how many threads to use, defaults to 2 * CPU's
--cache the cache directory, defaults to .workspace-cache
Commands
list list the packages in dependency order
--filter all: (default) all packages
not-cached: all packages that is not cached for the current version
cached: all packages that is cached for the current version
--hierarchy all: (default) don't filter based on hierarchy
shared: only shared packages
root: only root packages
--grep only packages which name matches the given glob pattern
--include-deps include the dependencies for all of the matching packages
--json output JSON objects
run run a npm script in each packages that contains that script
--filter all: (default) all packages
not-cached: all packages that is not cached for the current version
cached: all packages that is cached for the current version
--hierarchy all: (default) don't filter based on hierarchy
shared: only shared packages
root: only root packages
--grep only packages which name matches the given glob pattern
--include-deps runs scripts on all dependencies before the filtered packages
--ordered runs scripts on packages in topological order
exec <command> run a shell command in each packages
--filter all: (default) all packages
not-cached: all packages that is not cached for the current version
cached: all packages that is cached for the current version
--hierarchy all: (default) don't filter based on hierarchy
shared: only shared packages
root: only root packages
--grep only packages which name matches the given glob pattern
--include-deps runs the shell command on all dependencies before the filtered packages
--ordered runs the shell command on packages in topological order
write synchronizes to the cache
read synchronizes from the cache
clean clean the cache
--older-than n will clean files older than n days,
n must be between 0 and 120 and defaults to 30
Examples
workspace-cache list
workspace-cache list --filter cached
workspace-cache list --filter not-cached
workspace-cache list --hierarchy root
workspace-cache list --hierarchy root --grep "@common/*"
workspace-cache run build --ordered
workspace-cache run build --ordered --filter not-cached
workspace-cache run test --hierarchy root
workspace-cache run test -- -i
workspace-cache run test --grep "*streams"
workspace-cache run test --include-deps --grep "*stream"
workspace-cache exec ls
workspace-cache exec -- ls -l
workspace-cache exec --ordered -- make
workspace-cache write
workspace-cache read
workspace-cache clean
workspace-cache clean --older-than 3
```
## MIT License
Copyright (c) 2020 Sune Simonsen [email protected]
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.