🎬 Make code review, unit test, and CI/CD works the way just like github actions with typescript.
npx tsmk🧲 Ordering based on the needs field for synchronous execution of jobs
🕹️ Support execute commands in a mix of local and remote environments by ssh2
💻 Simple way to format and pass outputs to the next step defaults by destr
🎳 Support multiple types of config by joycon
🎁 Friendly command-line helps by citty
✨ No installation required - npx tsmk
# npm
npm i tsmk -D
# yarn
yarn add tsmk -D
# pnpm
pnpm add tsmk -DRun tsmk in terminal, typically at the same level as the tsmk.config file.
You can quick execute all your jobs with tsmk.
An alias for the tsmk
tsmk runCan also specify a single job or list of jobs.
tsmk run ci cdIf there are dependency relationships based on needs between jobs, tsmk will execute the dependent items by default.
This can be overridden by using the noNeeds parameter to run a specific job independently.
tsmk run cd --noNeedsNormally a job with dependencies will require the output of its dependencies.
And args can be achieved by adding parameters to the command line to inject values into the context.
tsmk run cd --noNeeds --image IMAGE:TAGIn the following example, IMAGE:TAG will be output to the console.
// tsmk.config.ts
import { defineConfig, run } from './src'
export default defineConfig({
jobs: {
ci: {
steps: [
'echo ci',
]
},
cd: {
needs: 'ci',
steps: [
run((_, ctx) => `echo ${ctx.args.image}`, { stdio: 'inherit' }),
]
}
},
})tsmk will execute jobs with order defined in the config file.
Create tsmk.config.ts
// tsmk.config.ts
import { defineConfig, run } from 'tsmk'
export default defineConfig({})You can use tsmk.config.{js,cjs,mjs,ts,mts,cts} to specify configuration.
String can also be used as a step in jobs, if there is no need to use the extended capabilities of run, you can defined the configuration file in tsmk.config.json file and execute it with npx tsmk.
Example
// tsmk.config.ts
import { defineConfig, run } from 'tsmk'
export default defineConfig({
jobs: {
ci: {
steps: [
run('echo Hello', { stdio: 'inherit' }),
'echo tsmk'
],
},
},
})tsmk exposes a run method to execute commands by execa.
run('echo Hello')Using run in job.steps also provides a simple way to obtain the output from the previous step.
Example
// tsmk.config.ts
import { defineConfig, run } from 'tsmk'
export default defineConfig({
jobs: {
ci: {
steps: [
run('echo tsmk'),
run((prev: string) => `echo Hello ${prev}`),
],
},
},
})You can also configure execa through the second parameter, see docs.
If stdio: inherit is set, the console will use the child process's output. prev will be undefined in the next step, recommend to use this only when console output needs to be viewed.
Here are some extra options in the second parameter of run:
export interface RunOptions extends ExecaOptions {
ssh: boolean
transform: (stdout: string) => any | Promise<any>
beforeExec: (ctx: TsmkContext) => any | Promise<any>
afterExec: (ctx: TsmkContext) => any | Promise<any>
}Example
In the following example, the console will output 2
// tsmk.config.ts
import { defineConfig, run } from 'tsmk'
export default defineConfig({
jobs: {
ci: {
steps: [
run('echo 1', { transform: stdout => Number(JSON.parse(stdout)) }),
run((prev: number) => `echo ${prev + 1}`, { stdio: 'inherit' }),
],
},
},
})You can also wrap a custom step by using defineRunner
Example
import { execa } from 'execa'
const echoHello = defineRunner((prev, ctx) => {
execa('echo', ['Hello'])
})And echoHello can be used in jobs like:
// tsmk.config.ts
import { defineConfig, run } from 'tsmk'
export default defineConfig({
jobs: {
ci: {
steps: [
echoHello
],
},
},
})For common commands, tsmk also provide some presets
Configuring connections in jobs through the ssh field to execute commands remotely and retrieve outputs.
If declared the ssh field, all steps under the current job will be executed remotely by default.
tsmk will create an SSH connection at the start of the current job and close it after all steps in the current job have been executed.
You can mixin local command execution by declaring ssh: false in run.
Example
In the following example, the first command will be executed remotely, and the second command will be executed locally.
// tsmk.config.ts
import { defineConfig, run } from 'tsmk'
export default defineConfig({
jobs: {
cd: {
ssh: {
host: process.env.SSH_HOST,
username: process.env.SSH_USERNAME,
password: process.env.SSH_PASSWORD,
},
steps: [
run('cd ~ && ls', { stdio: 'inherit' }),
run('cd ~ && ls', { stdio: 'inherit', ssh: false }),
],
},
},
})Jobs support ordering through the needs field in options.job with string or string[].
Example
In the following example, second will execute first, then first and fourth will execute sync, and finally, third will execute.
// tsmk.config.ts
import { defineConfig, run } from 'tsmk'
export default defineConfig({
jobs: {
first: {
needs: 'second',
steps: [
run('echo 1', { stdio: 'inherit' }),
],
},
second: {
steps: [
run('echo 2', { stdio: 'inherit' }),
],
},
third: {
needs: ['first', 'second'],
steps: [
run('echo 3', { stdio: 'inherit' }),
],
},
forth: {
needs: ['second'],
steps: [
run('echo 4', { stdio: 'inherit' }),
],
},
},
})- Type:
string | string[] - Default:
undefined
It will be used to extend the configuration, and the final config is merged result of extended options and user options with defu.
Example
// tsmk.config.base.ts
import { defineConfig, run } from 'tsmk'
export default defineConfig({
jobs: {
ci: {
steps: [
run('echo tsmk'),
],
},
},
})// tsmk.config.ts
export default defineConfig({
extends: ['./tsmk.config.base']
})- Type:
Record<string, Job> - Default:
{}
- Type:
() => Promise<any> - Default:
undefined
- Type:
() => Promise<any> - Default:
undefined
- Type:
SSH - Default:
undefined
interface SSH {
host: string
username: string
password: string
port?: number
}- Type:
() => Promise<any> - Default:
undefined
- Type:
() => Promise<any> - Default:
undefined
- Type:
() => Promise<any> - Default:
undefined
- Type:
() => Promise<any> - Default:
undefined
- Type:
() => Promise<any> - Default:
undefined
- Type:
(string | (() => Promise<string>))[] - Default:
[]