Skip to content

Commit

Permalink
renamed branches
Browse files Browse the repository at this point in the history
  • Loading branch information
dominikwilkowski committed Jun 15, 2020
1 parent 9a7ee91 commit a7bcecf
Show file tree
Hide file tree
Showing 33 changed files with 73 additions and 72 deletions.
77 changes: 39 additions & 38 deletions README.md
Expand Up @@ -7,14 +7,14 @@
╚═════╝ ╚═╝ ╚═════╝ ╚═╝ ╚═══╝ ╚═╝ ╚══════╝
```

![cfont styles](https://raw.githubusercontent.com/dominikwilkowski/cfonts/master/img/example1.png)
![cfont styles](https://raw.githubusercontent.com/dominikwilkowski/cfonts/released/img/example1.png)


<p align="center"><img src="https://raw.githubusercontent.com/dominikwilkowski/cfonts/master/img/example2.png" alt="api example"></p>
<p align="center"><img src="https://raw.githubusercontent.com/dominikwilkowski/cfonts/released/img/example2.png" alt="api example"></p>
<p align="center"><a href="https://nodei.co/npm/cfonts/"><img src="https://nodei.co/npm/cfonts.png?downloads=true" alt="npm status"></a></p>
<p align="center">
<a href="https://travis-ci.org/dominikwilkowski/cfonts"><img src="https://travis-ci.org/dominikwilkowski/cfonts.svg?branch=master" alt="build status"></a>
<a href='https://coveralls.io/github/dominikwilkowski/cfonts?branch=master'><img src='https://coveralls.io/repos/github/dominikwilkowski/cfonts/badge.svg?branch=master' alt='CFont Coverage Status' /></a>
<a href="https://travis-ci.org/dominikwilkowski/cfonts"><img src="https://travis-ci.org/dominikwilkowski/cfonts.svg?branch=released" alt="build status"></a>
<a href='https://coveralls.io/github/dominikwilkowski/cfonts?branch=released'><img src='https://coveralls.io/repos/github/dominikwilkowski/cfonts/badge.svg?branch=released' alt='CFont Coverage Status' /></a>
</p>

<p align="center">This is a silly little command line tool for sexy fonts in the console. <strong>Give your cli some love.</strong></p>
Expand Down Expand Up @@ -123,7 +123,7 @@ This shows a list of all available options.
$ cfonts --help
```

![Help command](https://raw.githubusercontent.com/dominikwilkowski/cfonts/master/img/help.png)
![Help command](https://raw.githubusercontent.com/dominikwilkowski/cfonts/released/img/help.png)


#### -V, --version
Expand All @@ -136,7 +136,7 @@ This shows the installed version.
$ cfonts --version
```

![Version command](https://raw.githubusercontent.com/dominikwilkowski/cfonts/master/img/version.png)
![Version command](https://raw.githubusercontent.com/dominikwilkowski/cfonts/released/img/version.png)


#### text
Expand All @@ -150,7 +150,7 @@ The `|` character will be replaced with a line break.
$ cfonts "Hello world"
```

![Text command](https://raw.githubusercontent.com/dominikwilkowski/cfonts/master/img/text.png)
![Text command](https://raw.githubusercontent.com/dominikwilkowski/cfonts/released/img/text.png)


#### -f, --font
Expand All @@ -163,34 +163,34 @@ This is the font face you want to use. So far this plugin ships with with follow
$ cfonts "text" --font "chrome"
```

![Font command](https://raw.githubusercontent.com/dominikwilkowski/cfonts/master/img/font.png)
![Font command](https://raw.githubusercontent.com/dominikwilkowski/cfonts/released/img/font.png)

- `block` [colors: 2] _(default)_
![block font style](https://raw.githubusercontent.com/dominikwilkowski/cfonts/master/img/block.png)
![block font style](https://raw.githubusercontent.com/dominikwilkowski/cfonts/released/img/block.png)
- `slick` [colors: 2]
![slick font style](https://raw.githubusercontent.com/dominikwilkowski/cfonts/master/img/slick.png)
![slick font style](https://raw.githubusercontent.com/dominikwilkowski/cfonts/released/img/slick.png)
- `tiny` [colors: 1]
![tiny font style](https://raw.githubusercontent.com/dominikwilkowski/cfonts/master/img/tiny.png)
![tiny font style](https://raw.githubusercontent.com/dominikwilkowski/cfonts/released/img/tiny.png)
- `grid` [colors: 2]
![grid font style](https://raw.githubusercontent.com/dominikwilkowski/cfonts/master/img/grid.png)
![grid font style](https://raw.githubusercontent.com/dominikwilkowski/cfonts/released/img/grid.png)
- `pallet` [colors: 2]
![pallet font style](https://raw.githubusercontent.com/dominikwilkowski/cfonts/master/img/pallet.png)
![pallet font style](https://raw.githubusercontent.com/dominikwilkowski/cfonts/released/img/pallet.png)
- `shade` [colors: 2]
![shade font style](https://raw.githubusercontent.com/dominikwilkowski/cfonts/master/img/shade.png)
![shade font style](https://raw.githubusercontent.com/dominikwilkowski/cfonts/released/img/shade.png)
- `chrome` [colors: 3]
![chrome font style](https://raw.githubusercontent.com/dominikwilkowski/cfonts/master/img/chrome.png)
![chrome font style](https://raw.githubusercontent.com/dominikwilkowski/cfonts/released/img/chrome.png)
- `simple` [colors: 1]
![simple font style](https://raw.githubusercontent.com/dominikwilkowski/cfonts/master/img/simple.png)
![simple font style](https://raw.githubusercontent.com/dominikwilkowski/cfonts/released/img/simple.png)
- `simpleBlock` [colors: 1]
![simple-block font style](https://raw.githubusercontent.com/dominikwilkowski/cfonts/master/img/simple-block.png)
![simple-block font style](https://raw.githubusercontent.com/dominikwilkowski/cfonts/released/img/simple-block.png)
- `3d` [colors: 2]
![3d font style](https://raw.githubusercontent.com/dominikwilkowski/cfonts/master/img/3d.png)
![3d font style](https://raw.githubusercontent.com/dominikwilkowski/cfonts/released/img/3d.png)
- `simple3d` [colors: 1]
![simple-3d font style](https://raw.githubusercontent.com/dominikwilkowski/cfonts/master/img/simple-3d.png)
![simple-3d font style](https://raw.githubusercontent.com/dominikwilkowski/cfonts/released/img/simple-3d.png)
- `huge` [colors: 2]
![huge font style](https://raw.githubusercontent.com/dominikwilkowski/cfonts/master/img/huge.png)
![huge font style](https://raw.githubusercontent.com/dominikwilkowski/cfonts/released/img/huge.png)
- `console` [colors: 1]
![console font style](https://raw.githubusercontent.com/dominikwilkowski/cfonts/master/img/console.png)
![console font style](https://raw.githubusercontent.com/dominikwilkowski/cfonts/released/img/console.png)


#### -a, --align
Expand All @@ -207,7 +207,7 @@ You can align your text in the terminal with this option. Use the keywords below
$ cfonts "text" --align "center"
```

![Align command](https://raw.githubusercontent.com/dominikwilkowski/cfonts/master/img/align.png)
![Align command](https://raw.githubusercontent.com/dominikwilkowski/cfonts/released/img/align.png)


#### -c, --colors
Expand Down Expand Up @@ -244,7 +244,7 @@ The `system` color falls back to the system color of your terminal.
$ cfonts "text" --colors white,"#f80"
```

![Colors command](https://raw.githubusercontent.com/dominikwilkowski/cfonts/master/img/colors.png)
![Colors command](https://raw.githubusercontent.com/dominikwilkowski/cfonts/released/img/colors.png)


#### -g, --gradient
Expand Down Expand Up @@ -276,7 +276,7 @@ If you use a hex color make sure you include the `#` prefix. _(In the terminal w
$ cfonts "text" --gradient red,"#f80"
```

![Gradient command](https://raw.githubusercontent.com/dominikwilkowski/cfonts/master/img/gradient.png)
![Gradient command](https://raw.githubusercontent.com/dominikwilkowski/cfonts/released/img/gradient.png)


#### -i, --independent-gradient
Expand All @@ -290,7 +290,7 @@ Only works in combination with the [gradient](#-g---gradient) option.
$ cfonts "text|next line" --gradient red,"#f80" --independent-gradient
```

![Independent gradient command](https://raw.githubusercontent.com/dominikwilkowski/cfonts/master/img/independent-gradient.png)
![Independent gradient command](https://raw.githubusercontent.com/dominikwilkowski/cfonts/released/img/independent-gradient.png)


#### -t, --transition-gradient
Expand All @@ -306,7 +306,7 @@ Only works in combination with the [gradient](#-g---gradient) option.
$ cfonts "text" --gradient red,"#f80",green,blue --transition-gradient
```

![Independent gradient command](https://raw.githubusercontent.com/dominikwilkowski/cfonts/master/img/transition-gradient.png)
![Independent gradient command](https://raw.githubusercontent.com/dominikwilkowski/cfonts/released/img/transition-gradient.png)


#### -b, --background
Expand Down Expand Up @@ -338,7 +338,7 @@ Provide the background color from the below supported list, eg: 'white'
$ cfonts "text" --background "Green"
```

![Background command](https://raw.githubusercontent.com/dominikwilkowski/cfonts/master/img/background.png)
![Background command](https://raw.githubusercontent.com/dominikwilkowski/cfonts/released/img/background.png)


#### -l, --letter-spacing
Expand All @@ -351,7 +351,7 @@ Set this option to widen the space between characters.
$ cfonts "text" --letter-spacing 2
```

![Letter spacing command](https://raw.githubusercontent.com/dominikwilkowski/cfonts/master/img/letter-spacing.png)
![Letter spacing command](https://raw.githubusercontent.com/dominikwilkowski/cfonts/released/img/letter-spacing.png)


#### -z, --line-height
Expand All @@ -364,7 +364,7 @@ Set this option to widen the space between lines.
$ cfonts "text" --line-height 2
```

![Line height command](https://raw.githubusercontent.com/dominikwilkowski/cfonts/master/img/line-height.png)
![Line height command](https://raw.githubusercontent.com/dominikwilkowski/cfonts/released/img/line-height.png)


#### -s, --spaceless
Expand All @@ -377,7 +377,7 @@ Set this option to false if you don't want the plugin to insert two empty lines
$ cfonts "text" --spaceless
```

![Spaceless command](https://raw.githubusercontent.com/dominikwilkowski/cfonts/master/img/spaceless.png)
![Spaceless command](https://raw.githubusercontent.com/dominikwilkowski/cfonts/released/img/spaceless.png)


#### -m, --max-length
Expand All @@ -392,7 +392,7 @@ CFonts detects the size of your terminal but you can opt out and determine your
$ cfonts "text" --max-length 15
```

![Max length command](https://raw.githubusercontent.com/dominikwilkowski/cfonts/master/img/max-length.png)
![Max length command](https://raw.githubusercontent.com/dominikwilkowski/cfonts/released/img/max-length.png)


#### -e, --env
Expand Down Expand Up @@ -425,7 +425,7 @@ fs.writeFileSync(
);
```

![Max length command](https://raw.githubusercontent.com/dominikwilkowski/cfonts/master/img/env.png)
![Max length command](https://raw.githubusercontent.com/dominikwilkowski/cfonts/released/img/env.png)


## Consistency
Expand Down Expand Up @@ -455,7 +455,7 @@ Please look at the coding style and work with it, not against it ;)


## Tests
This package is tested on the below platform and node combinations as part of our [CI](https://github.com/dominikwilkowski/cfonts/tree/master/.travis.yml).
This package is tested on the below platform and node combinations as part of our [CI](https://github.com/dominikwilkowski/cfonts/tree/released/.travis.yml).

| Platform | Node |
|----------|--------|
Expand All @@ -470,8 +470,8 @@ This package is tested on the below platform and node combinations as part of ou
| Windows | latest |

### Unit tests
The package comes with a bunch of [unit tests](https://github.com/dominikwilkowski/cfonts/tree/master/test/unit) that aim to cover 100% of the code base.
For more details about the code coverage check out [coveralls](https://coveralls.io/github/dominikwilkowski/cfonts?branch=master).
The package comes with a bunch of [unit tests](https://github.com/dominikwilkowski/cfonts/tree/released/test/unit) that aim to cover 100% of the code base.
For more details about the code coverage check out [coveralls](https://coveralls.io/github/dominikwilkowski/cfonts?branch=released).

```shell
npm run test:unit
Expand All @@ -480,14 +480,14 @@ npm run test:unit
### Type tests
Since the code base uses [JSDocs](https://jsdoc.app/) we use [typescript](https://www.typescriptlang.org/) to test the inferred types from those comments.
Typescript [supports JSDocs](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html#supported-jsdoc) and we use it in our
[test](https://github.com/dominikwilkowski/cfonts/blob/master/package.json#L38).
[test](https://github.com/dominikwilkowski/cfonts/blob/released/package.json#L38).

```shell
npm run test:types
```

### Font file test
There is also a [test suite](https://github.com/dominikwilkowski/cfonts/blob/master/test/fonttest.js) for font files.
There is also a [test suite](https://github.com/dominikwilkowski/cfonts/blob/released/test/fonttest.js) for font files.

```shell
npm run test:fonts
Expand All @@ -510,6 +510,7 @@ npm run test


## Release History
* 2.8.5 - renamed branches
* 2.8.4 - fixed block double quote
* 2.8.3 - bumped dependencies
* 2.8.2 - bumped dependencies, added linting, fixed #22 (again)
Expand Down Expand Up @@ -566,4 +567,4 @@ npm run test


## License
Copyright (c) 2018 Dominik Wilkowski. Licensed under the [GNU GPLv2](https://github.com/dominikwilkowski/cfonts/blob/master/LICENSE).
Copyright (c) 2018 Dominik Wilkowski. Licensed under the [GNU GPLv2](https://github.com/dominikwilkowski/cfonts/blob/released/LICENSE).
4 changes: 2 additions & 2 deletions package.json
@@ -1,7 +1,7 @@
{
"name": "cfonts",
"description": "Sexy fonts for the console",
"version": "2.8.4",
"version": "2.8.5",
"homepage": "https://github.com/dominikwilkowski/cfonts",
"author": {
"name": "Dominik Wilkowski",
Expand All @@ -23,7 +23,7 @@
"licenses": [
{
"type": "GPL-2.0",
"url": "https://github.com/dominikwilkowski/cfonts/blob/master/LICENSE"
"url": "https://github.com/dominikwilkowski/cfonts/blob/released/LICENSE"
}
],
"engines": {
Expand Down
2 changes: 1 addition & 1 deletion src/AddChar.js
Expand Up @@ -4,7 +4,7 @@
*
* Sexy fonts for the console. (CLI output)
*
* @license https://github.com/dominikwilkowski/cfonts/blob/master/LICENSE GNU GPLv2
* @license https://github.com/dominikwilkowski/cfonts/blob/released/LICENSE GNU GPLv2
* @author Dominik Wilkowski hi@dominik-wilkowski.com
* @repository https://github.com/dominikwilkowski/cfonts
*
Expand Down
2 changes: 1 addition & 1 deletion src/AddLetterSpacing.js
Expand Up @@ -4,7 +4,7 @@
*
* Sexy fonts for the console. (CLI output)
*
* @license https://github.com/dominikwilkowski/cfonts/blob/master/LICENSE GNU GPLv2
* @license https://github.com/dominikwilkowski/cfonts/blob/released/LICENSE GNU GPLv2
* @author Dominik Wilkowski hi@dominik-wilkowski.com
* @repository https://github.com/dominikwilkowski/cfonts
*
Expand Down
2 changes: 1 addition & 1 deletion src/AddLine.js
Expand Up @@ -4,7 +4,7 @@
*
* Sexy fonts for the console. (CLI output)
*
* @license https://github.com/dominikwilkowski/cfonts/blob/master/LICENSE GNU GPLv2
* @license https://github.com/dominikwilkowski/cfonts/blob/released/LICENSE GNU GPLv2
* @author Dominik Wilkowski hi@dominik-wilkowski.com
* @repository https://github.com/dominikwilkowski/cfonts
*
Expand Down
2 changes: 1 addition & 1 deletion src/AddShortcuts.js
Expand Up @@ -4,7 +4,7 @@
*
* Sexy fonts for the console. (CLI output)
*
* @license https://github.com/dominikwilkowski/cfonts/blob/master/LICENSE GNU GPLv2
* @license https://github.com/dominikwilkowski/cfonts/blob/released/LICENSE GNU GPLv2
* @author Dominik Wilkowski hi@dominik-wilkowski.com
* @repository https://github.com/dominikwilkowski/cfonts
*
Expand Down
2 changes: 1 addition & 1 deletion src/AlignText.js
Expand Up @@ -4,7 +4,7 @@
*
* Sexy fonts for the console. (CLI output)
*
* @license https://github.com/dominikwilkowski/cfonts/blob/master/LICENSE GNU GPLv2
* @license https://github.com/dominikwilkowski/cfonts/blob/released/LICENSE GNU GPLv2
* @author Dominik Wilkowski hi@dominik-wilkowski.com
* @repository https://github.com/dominikwilkowski/cfonts
*
Expand Down
2 changes: 1 addition & 1 deletion src/Chalk.js
Expand Up @@ -4,7 +4,7 @@
*
* Sexy fonts for the console. (CLI output)
*
* @license https://github.com/dominikwilkowski/cfonts/blob/master/LICENSE GNU GPLv2
* @license https://github.com/dominikwilkowski/cfonts/blob/released/LICENSE GNU GPLv2
* @author Dominik Wilkowski hi@dominik-wilkowski.com
* @repository https://github.com/dominikwilkowski/cfonts
*
Expand Down
2 changes: 1 addition & 1 deletion src/CharLength.js
Expand Up @@ -4,7 +4,7 @@
*
* Sexy fonts for the console. (CLI output)
*
* @license https://github.com/dominikwilkowski/cfonts/blob/master/LICENSE GNU GPLv2
* @license https://github.com/dominikwilkowski/cfonts/blob/released/LICENSE GNU GPLv2
* @author Dominik Wilkowski hi@dominik-wilkowski.com
* @repository https://github.com/dominikwilkowski/cfonts
*
Expand Down
2 changes: 1 addition & 1 deletion src/CheckInput.js
Expand Up @@ -4,7 +4,7 @@
*
* Sexy fonts for the console. (CLI output)
*
* @license https://github.com/dominikwilkowski/cfonts/blob/master/LICENSE GNU GPLv2
* @license https://github.com/dominikwilkowski/cfonts/blob/released/LICENSE GNU GPLv2
* @author Dominik Wilkowski hi@dominik-wilkowski.com
* @repository https://github.com/dominikwilkowski/cfonts
*
Expand Down
2 changes: 1 addition & 1 deletion src/CleanInput.js
Expand Up @@ -4,7 +4,7 @@
*
* Sexy fonts for the console. (CLI output)
*
* @license https://github.com/dominikwilkowski/cfonts/blob/master/LICENSE GNU GPLv2
* @license https://github.com/dominikwilkowski/cfonts/blob/released/LICENSE GNU GPLv2
* @author Dominik Wilkowski hi@dominik-wilkowski.com
* @repository https://github.com/dominikwilkowski/cfonts
*
Expand Down
2 changes: 1 addition & 1 deletion src/Color.js
Expand Up @@ -4,7 +4,7 @@
*
* Sexy fonts for the console. (CLI output)
*
* @license https://github.com/dominikwilkowski/cfonts/blob/master/LICENSE GNU GPLv2
* @license https://github.com/dominikwilkowski/cfonts/blob/released/LICENSE GNU GPLv2
* @author Dominik Wilkowski hi@dominik-wilkowski.com
* @repository https://github.com/dominikwilkowski/cfonts
*
Expand Down
2 changes: 1 addition & 1 deletion src/Colorize.js
Expand Up @@ -4,7 +4,7 @@
*
* Sexy fonts for the console. (CLI output)
*
* @license https://github.com/dominikwilkowski/cfonts/blob/master/LICENSE GNU GPLv2
* @license https://github.com/dominikwilkowski/cfonts/blob/released/LICENSE GNU GPLv2
* @author Dominik Wilkowski hi@dominik-wilkowski.com
* @repository https://github.com/dominikwilkowski/cfonts
*
Expand Down
2 changes: 1 addition & 1 deletion src/Debugging.js
Expand Up @@ -4,7 +4,7 @@
*
* Sexy fonts for the console. (CLI output)
*
* @license https://github.com/dominikwilkowski/cfonts/blob/master/LICENSE GNU GPLv2
* @license https://github.com/dominikwilkowski/cfonts/blob/released/LICENSE GNU GPLv2
* @author Dominik Wilkowski hi@dominik-wilkowski.com
* @repository https://github.com/dominikwilkowski/cfonts
*
Expand Down
2 changes: 1 addition & 1 deletion src/DisplayHelp.js
Expand Up @@ -4,7 +4,7 @@
*
* Sexy fonts for the console. (CLI output)
*
* @license https://github.com/dominikwilkowski/cfonts/blob/master/LICENSE GNU GPLv2
* @license https://github.com/dominikwilkowski/cfonts/blob/released/LICENSE GNU GPLv2
* @author Dominik Wilkowski hi@dominik-wilkowski.com
* @repository https://github.com/dominikwilkowski/cfonts
*
Expand Down
2 changes: 1 addition & 1 deletion src/DisplayVersion.js
Expand Up @@ -4,7 +4,7 @@
*
* Sexy fonts for the console. (CLI output)
*
* @license https://github.com/dominikwilkowski/cfonts/blob/master/LICENSE GNU GPLv2
* @license https://github.com/dominikwilkowski/cfonts/blob/released/LICENSE GNU GPLv2
* @author Dominik Wilkowski hi@dominik-wilkowski.com
* @repository https://github.com/dominikwilkowski/cfonts
*
Expand Down

0 comments on commit a7bcecf

Please sign in to comment.