Skip to content

Latest commit

 

History

History
131 lines (83 loc) · 3.38 KB

README.md

File metadata and controls

131 lines (83 loc) · 3.38 KB
Raw

Web-Fonts CLI

npm npm npm

Note: This CLI does not create web font files from .ttf or something like that.

This is just a web-font package generator for the Web-Fonts project, so install it if you are contributor only.

Installation

$ npm install web-fonts-cli -g

Usage

Create Web Fonts

Create font.json file with the containing data (or run the init command, see below):

{
  "name": "Font Name",
  "author": "Font Author",
  "version": "1.0.0"
}
  • name will be used in .css files as a font-family and etc.
  • author will be used in README.md as credits.
  • version will be used in package manager configuration file (bower.json, package.json). default is: 1.0.0. Uses Semantic Versioning.

Place font files in fonts directory and run the following commands:

(it does not matter, what you'll call the font files, after running the create command it will rename it correspondingly)

$ cd /fonts_package_dir
$ web-fonts create

Optional -f flag, forces to clean previously created files.

$ web-fonts create -f

Remove Generated Files

This command will remove everything, that was generated with the create command.

$ web-fonts clean

Publishing Package

To publish package on Git run the following command:

Note: This command should be called only ONCE and only 1st time, after creating a package.

$ web-fonts publish git

To publish package on Bower run the following command:

$ web-fonts publish bower

To publish package on NPM run the following command:

$ web-fonts publish npm
# or
$ npm publish

Init Package

To automatically create /fonts directory and font.json file containing the default settings, run the following command:

$ web-fonts init

You can also pass the font name, font author and font version as optional flags and arguments to the init method:

$ web-fonts init -n "My Font Name" -a "Font Author" -r 1.2.3

or use full flag names:

$ web-fonts init --name "My Font Name" --author "Font Author" --release 1.2.3

The release, flag will be used as version in package manager systems and it must be the semver object.

Note: Please do not put the -V, -v, or --version flag to the init method. This flag just outputs the current version of the Web-Fonts CLI. Use --release or -r flag instead.

If you have already initialized or created font.json file and want to replace it's options, add the -f or --force flag at the end of the command:

$ web-fonts init --name "My Font Name" --author "Font Author" --release 1.2.4 -f # or --force

Help

Run the following commands to display the help message.

$ web-fonts -h
$ # or
$ web-fonts --help

If you won't pass any arguments to web-fonts command, it will display help information automatically.

License

The Web-Fonts CLI package is open-sourced software licensed under the MIT license.