sierpinski-carpet-cli

1.2.0 • Public • Published

sierpinski-carpet-cli

Print the Sierpinski Carpet to the console!

What sierpinski-carpet-cli prints to the console

npm version bundle size downloads license

Why the console? Because it's the cool way.

See All Fractals in the fractals-cli project.

Usage

Via npx:

$ npx sierpinski-carpet-cli <n>
$ npx sierpinski-carpet-cli <n> [size] [options]

where n >= 0 and size >= n (if provided).

Via Global Install

$ npm install --global sierpinski-carpet-cli
$ sierpinski-carpet-cli <n>
$ sierpinski-carpet-cli <n> [size] [options]

where n >= 0 and size >= n (if provided).

Via Import

$ npm install sierpinski-carpet-cli

then:

const sierpinski = require('sierpinski-carpet-cli');
console.log(sierpinski.create(<n>);
console.log(sierpinski.create(<n>, { 
    size: <number>, 
    inverse: <boolean>, 
    character: <character> 
}));

The config params are optional.

Options

Recursive Step

$ sierpinski-carpet-cli <n>

The first param <n> is the recursive step. <n> should be an integer greater than or equal to 0.

Examples:

$ sierpinski-carpet-cli 2

What sierpinski-carpet-cli prints to the console

$ sierpinski-carpet-cli 3

What sierpinski-carpet-cli prints to the console

Size

$ sierpinski-carpet-cli <n> [size]

The optional [size] param allows the Sierpinski Carpet to be drawn at larger sizes. [size] should be an integer greater than or equal to <n>. Including size will draw a Sierpinski Carpet of <n> recursive steps the size of a Sierpinski Carpet with [size] recursive steps.

Example:

$ sierpinski-carpet-cli 2 3

What sierpinski-carpet-cli prints to the console

Inverse

$ sierpinski-carpet-cli <n> --inverse

The optional --inverse param (or shorthand -i) will draw the inverse squares.

Example:

$ sierpinski-carpet-cli 3 --inverse

What sierpinski-carpet-cli prints to the console

Custom Characters

$ sierpinski-carpet-cli <n> --character=<character>

The optional --character=<character> param will draw sqaures using the provided character. (Please provide only 1 character)

Example:

$ sierpinski-carpet-cli 2 3 --character=*

What sierpinski-carpet-cli prints to the console

By default, squares are drawn using ANSI inverse codes: \u001b[7m. To instead draw using unicode block characters, add the --blocks param (or shorthand -b).

$ sierpinski-carpet-cli <n> --blocks

(May look better/worse on certain terminals)

Related

Main Project

Fractal Shapes

Fractal Patterns

Space Filling Curves

License

Package Sidebar

Install

npm i sierpinski-carpet-cli

Weekly Downloads

4

Version

1.2.0

License

MIT

Unpacked Size

15.2 kB

Total Files

5

Last publish

Collaborators

  • spirometaxas