Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
makfy - npm Package Compare versions
Comparing version 1.0.3 to 1.0.4
| # makfy changelog | ||
| ## 0.5.0 | ||
| ## 1.0.0 | ||
| - first beta release | ||
| - first release |
| { | ||
| "name": "makfy", | ||
| "version": "1.0.3", | ||
| "version": "1.0.4", | ||
| "description": "makfy - npm scripts on steroids!", | ||
@@ -5,0 +5,0 @@ "main": "dist/lib/index.js", |
@@ -183,2 +183,3 @@ <p align="center"> | ||
| In more detail: | ||
| ### ```commands: { [commandName]: Command }``` | ||
@@ -188,9 +189,9 @@ ```commands``` is an object with alphanumeric keys, which are the command names. | ||
| #### ```Command: { run, desc?, args? }``` | ||
| * ##### ```run: async(exec, args, utils) => Promise<void>``` | ||
| * **```run: async(exec, args, utils) => Promise<void>```** | ||
| > An async function that takes three arguments, ```exec```, ```args``` and ```utils```. | ||
| > | ||
| > * ###### ```exec: async(...commands: ExecCommand[]) => Promise<void>``` | ||
| > * **```exec: async(...commands: ExecCommand[]) => Promise<void>```** | ||
| > > A function that allows you to run ```ExecCommand```(s) sequentially, which can be: | ||
| > > | ||
| > > * ###### shell string (e.g. ```'npm install'```) - ```string``` | ||
| > > * **shell string (e.g. ```'npm install'```) - ```string```** | ||
| > > > It will run the given command in the shell. | ||
@@ -203,6 +204,6 @@ > > > | ||
| > > | ||
| > > * ###### help string (e.g. ```'? installing packages'```) - ```string``` | ||
| > > * **help string (e.g. ```'? installing packages'```) - ```string```** | ||
| > > > It will print that help to the console, useful to keep track of what your build is doing. | ||
| > > | ||
| > > * ###### command invocation object - ```{ _: 'commandName', args?: object }``` | ||
| > > * **command invocation object - ```{ _: 'commandName', args?: object }```** | ||
| > > > It will run another command inside the current command, optionally passing it the given arguments if desired. | ||
@@ -214,3 +215,3 @@ > > > | ||
| > > | ||
| > > * ###### exec-command array (e.g. ```[ 'npm install', '@clean' ]```) - ```ExecCommand[]``` | ||
| > > * **exec-command array (e.g. ```[ 'npm install', '@clean' ]```) - ```ExecCommand[]```** | ||
| > > > It will run whatever is inside but in parallel instead of sequentially. If an array is used inside another array then it will go back to run sequentially. | ||
@@ -234,31 +235,31 @@ > > > | ||
| > | ||
| > * ###### ```args: object``` | ||
| > * **```args: object```** | ||
| > > An object where each property is the argument value as coming from the command line or exec sub-command invocation. | ||
| > | ||
| > * ###### ```utils: object``` | ||
| > * **```utils: object```** | ||
| > > An object with nifty utility methods: | ||
| > > | ||
| > > * ###### ```filesChanged: async([gobPatterns: string[] | string], log = true) => Promise<boolean>``` | ||
| > > * **```filesChanged: async([gobPatterns: string[] | string], log = true) => Promise<boolean>```** | ||
| > > > Returns true if any of the files represented from the union of all gob pattern(s) changed. Useful for example if you don't need to rerun the babel if none of the sources changed. | ||
| > > > | ||
| > > > Note that this function will create files inside a ```.makfy-cache``` folder. | ||
| > > * ###### ```cleanCacheSync: () => void``` | ||
| > > * **```cleanCacheSync: () => void```** | ||
| > > > Cleans the ```.makfy-cache``` folder. Use it if you want to make sure all next calls to ```filesChanged``` will be true. | ||
| * #### ```desc?: string``` | ||
| * **```desc?: string```** | ||
| > An optional property that defines what the command does so it is shown when using ```makfy --list```. | ||
| * #### ```args?: { [argName]: ArgDefinition }``` | ||
| * **```args?: { [argName]: ArgDefinition }```** | ||
| > An optional object of argument definitions that can be passed to that command using ```makfy commandName ...args``` and that will be automatically validated. | ||
| > | ||
| > An ```ArgDefinition``` can be: | ||
| > * ###### Flag option - ```{ type: 'flag' }``` | ||
| > * **Flag option - ```{ type: 'flag' }```** | ||
| > | ||
| > > An optional flag, false by default unless you use ```--argName``` | ||
| > | ||
| > * ###### String option - ```{ type: 'string', byDefault?: string }``` | ||
| > * **String option - ```{ type: 'string', byDefault?: string }```** | ||
| > | ||
| > > A string option, required if no ```byDefault``` is given (```--argName=string```, use quotes if it has to have spaces) | ||
| > | ||
| > * ###### Enum option - ```{ type: 'enum', values: string[], byDefault?: string }``` | ||
| > * **Enum option - ```{ type: 'enum', values: string[], byDefault?: string }```** | ||
| > | ||
@@ -265,0 +266,0 @@ > > An enum option where only ```values``` are valid, required if no ```byDefault``` is given (```--argName=string```) |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Number of lines in readme file
- increased by0.36%
275
Worsened metrics
- Total package byte prevSize
- decreased by-0.02%
247622
No dependency changes