1
0
Fork 0
toolkit/packages/io
Josh Soref 7257597d73
Spelling (#431)
* spelling: absolute

* spelling: content

* spelling: received

* spelling: sanitizes
2020-04-27 09:13:56 -04:00
..
__tests__ Spelling (#431) 2020-04-27 09:13:56 -04:00
src Comment nit 2019-08-21 12:54:24 -04:00
README.md io/README.md 2019-08-21 01:18:21 -04:00
RELEASES.md release notes (#308) 2020-01-14 11:58:44 -05:00
package-lock.json audit fix and update http-client (#298) 2020-01-10 16:37:48 -05:00
package.json bump versions (#295) 2020-01-09 17:31:27 -05:00
tsconfig.json Add io (#5) 2019-05-22 16:05:34 -04:00

README.md

@actions/io

Core functions for cli filesystem scenarios

Usage

mkdir -p

Recursively make a directory. Follows rules specified in man mkdir with the -p option specified:

const io = require('@actions/io');

await io.mkdirP('path/to/make');

cp/mv

Copy or move files or folders. Follows rules specified in man cp and man mv:

const io = require('@actions/io');

// Recursive must be true for directories
const options = { recursive: true, force: false }

await io.cp('path/to/directory', 'path/to/dest', options);
await io.mv('path/to/file', 'path/to/dest');

rm -rf

Remove a file or folder recursively. Follows rules specified in man rm with the -r and -f rules specified.

const io = require('@actions/io');

await io.rmRF('path/to/directory');
await io.rmRF('path/to/file');

which

Get the path to a tool and resolves via paths. Follows the rules specified in man which.

const exec = require('@actions/exec');
const io = require('@actions/io');

const pythonPath: string = await io.which('python', true)

await exec.exec(`"${pythonPath}"`, ['main.py']);