fair-principles
TypeScript icon, indicating that this package has built-in type declarations

2.0.0 • Public • Published

fair-principles

fair-principles on npm MIT License CI

A tiny utility to show FAIR Principles in your application. Used under the CC-BY License from GO FAIR.

npm install fair-principles

The library has no dependencies, however it works well with chalk!

import chalk from 'chalk';
import { formatPrinciples } from 'fair-principles';

console.log(formatPrinciples('*', { chalk }));

formatPrinciples

Formats the list of FAIR principles with a title.

  • formatPrinciples() - format all principles
  • formatPrinciples('*', { chalk, showTitle: false }) - format all principles with a chalk logger and without the title
  • formatPrinciples('A*') - format all "Accessible" principles
  • formatPrinciples(['A*', 'F']) - formats the "Findable" principle (no children) and then all "Accessible" principles
import chalk from 'chalk';
import { formatPrinciples } from 'fair-principles';

console.log(formatPrinciples('A*', { chalk }));

formatPrinciple

Formats a single FAIR principle, possibly with a header.

  • formatPrinciple('R') - format the "Reusable" principle, including the header
  • formatPrinciple('R', { showHeader: false }) - format the "Reusable" principle, without the header
  • formatPrinciple('R1_1') - Show the the "Reusable" sub-principle.
import chalk from 'chalk';
import { formatPrinciples } from 'fair-principles';

console.log(formatPrinciples('A*', { chalk }));

highlightFAIR

Highlights the word FAIR with a specific color, for example, with an underline or in red (the default).

import chalk from 'chalk';
import { highlightFAIR } from 'fair-principles';

highlightFAIR('A', { color: chalk.underline });

Format Options

All format calls can take chalk as an argument, this will apply defaults. You can also specify:

  • indent: (boolean): Indent sub-principles (for example A1_1), default is true
  • showTitle: (boolean): Shows the title "FAIR Principles"
  • showHeader: (boolean): Show a header like "Accessible" before the "A" principle
  • title: (Formatter): A color formatter for the title
  • header: (Formatter): A color formatter for the header
  • enumerator: (Formatter): A color formatter for the enumerator (e.g. A1)

As of v2.0.0 this package is ESM only.


Made with love by Curvenote

Readme

Keywords

Package Sidebar

Install

npm i fair-principles

Weekly Downloads

1,404

Version

2.0.0

License

MIT

Unpacked Size

12.9 kB

Total Files

5

Last publish

Collaborators

  • rowanc1
  • stevejpurves