Skip to content

sndrs/ok

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

87 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

ok

๐Ÿ™‡โ€โ™‚๏ธ An obliging task runner

Run npm-scripts in the correct environment without further installation or config.

Install

NPM version

$ yarn global add @sndrs/ok

or

$ npm install -g @sndrs/ok

Then use it to run your npm-scripts:

$ ok test # etc...

Changes the host env as little as possible

ok uses nvexeca behind the scenes. This means:

  • it does not need to make changes to $PATH
  • it does not affect existing Node versions
  • it does not affect NVM, fnm etc

Follows project conventions

  • uses correct Node version, observing .nvmrc, engines and more
  • uses the correct package manager for the project (yarn, npm or pnpm)
    • observes engines.npm if present (unlike npm)
  • always run tasks with up-to-date dependencies

No further dependencies

  • uses its own copy of yarn if it cannot find one
  • no nvm/n/fnm etc needed

Experience

  • All task output is shown โ€“ no magic
  • All available scripts in current context are discoverable by running without args (> ok)
  • Notifies you if you're using out-of-date version

See also