/fyord-cli

A companion CLI to the Fyord framework

Primary LanguageTypeScriptMIT LicenseMIT

fyord-cli

A companion CLI to the Fyord framework.

Features

  • Scaffold new fyord projects
  • Generate components, pages, etc.
    • Including .spec and css modules files where applicable
  • Pre-render a fyord application
  • and more!

Quick start

Install globally for the best experience - npm i -g fyord-cli

Once installed, run any of the following to run help and learn about the fyord-cli:

  • fyord (runs help when no arguments given)
  • fyord help
  • fyord h (aliased help command)

Contributors

Code of conduct

Installation

  • npm i

Local Dev

  • npm start
  • fyord will then be available as a command in your shell to test. Re-run npm start between changes to update the local copy.
  • You may have to remove fyord-cli from your global node_modules from time to time.

Test

  • npm test
  • npm test-once

Lint

  • npm run lint

Build (with source maps)

  • npm run build

Publish to npm (CI)

  • Update ./dist/package.json version*.
  • Merge changes to trunk (main) branch.
    • Assuming the build passes and the version in the ./dist/package.json has been updated, CI will publish the new version.

*Use Semantic Versioning (MAJOR.MINOR.PATCH - 1.1.1)

  • MAJOR version when you make incompatible API changes
  • MINOR version when you add functionality in a backwards compatible manner
  • PATCH version when you make backwards compatible bug fixes.

Consider changes relative to src/index.ts to be changes to the api.