{"id":27275165,"url":"https://github.com/continuous-foundation/fair-principles","last_synced_at":"2026-01-30T22:39:16.863Z","repository":{"id":63918191,"uuid":"571795480","full_name":"continuous-foundation/fair-principles","owner":"continuous-foundation","description":"A small utility to show FAIR Principles in your node or javascript application.","archived":false,"fork":false,"pushed_at":"2024-11-29T22:39:35.000Z","size":766,"stargazers_count":2,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-09-30T00:13:26.283Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/continuous-foundation.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-11-28T22:39:17.000Z","updated_at":"2024-11-29T22:39:39.000Z","dependencies_parsed_at":"2024-06-21T17:41:08.930Z","dependency_job_id":"a96082b6-fea8-4630-a120-fa8391e65e71","html_url":"https://github.com/continuous-foundation/fair-principles","commit_stats":{"total_commits":12,"total_committers":1,"mean_commits":12.0,"dds":0.0,"last_synced_commit":"c3f333f7785167083ef8b297ffb98533eebbcacd"},"previous_names":["continuous-foundation/fair-principles"],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/continuous-foundation/fair-principles","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/continuous-foundation%2Ffair-principles","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/continuous-foundation%2Ffair-principles/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/continuous-foundation%2Ffair-principles/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/continuous-foundation%2Ffair-principles/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/continuous-foundation","download_url":"https://codeload.github.com/continuous-foundation/fair-principles/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/continuous-foundation%2Ffair-principles/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28921453,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-30T22:32:35.345Z","status":"ssl_error","status_checked_at":"2026-01-30T22:32:31.927Z","response_time":66,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-04-11T15:30:59.380Z","updated_at":"2026-01-30T22:39:16.849Z","avatar_url":"https://github.com/continuous-foundation.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# fair-principles\n\n[![fair-principles on npm](https://img.shields.io/npm/v/fair-principles.svg)](https://www.npmjs.com/package/fair-principles)\n[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/continuous-foundation/fair-principles/blob/main/LICENSE)\n![CI](https://github.com/continuous-foundation/fair-principles/workflows/CI/badge.svg)\n\nA tiny utility to show [FAIR Principles](https://www.go-fair.org/fair-principles/) in your application. Used under the CC-BY License from [GO FAIR](https://www.go-fair.org/fair-principles/).\n\n```shell\nnpm install fair-principles\n```\n\nThe library has **no dependencies**, however it works well with `chalk`!\n\n```typescript\nimport chalk from 'chalk';\nimport { formatPrinciples } from 'fair-principles';\n\nconsole.log(formatPrinciples('*', { chalk }));\n```\n\n![](https://raw.githubusercontent.com/continuous-foundation/fair-principles/main/images/all-principles.png)\n\n## formatPrinciples\n\nFormats the list of FAIR principles with a title.\n\n- `formatPrinciples()` - format all principles\n- `formatPrinciples('*', { chalk, showTitle: false })` - format all principles with a chalk logger and without the title\n- `formatPrinciples('A*')` - format all \"Accessible\" principles\n- `formatPrinciples(['A*', 'F'])` - formats the \"Findable\" principle (no children) and then all \"Accessible\" principles\n\n```typescript\nimport chalk from 'chalk';\nimport { formatPrinciples } from 'fair-principles';\n\nconsole.log(formatPrinciples('A*', { chalk }));\n```\n\n## formatPrinciple\n\nFormats a single FAIR principle, possibly with a header.\n\n- `formatPrinciple('R')` - format the \"Reusable\" principle, including the header\n- `formatPrinciple('R', { showHeader: false })` - format the \"Reusable\" principle, without the header\n- `formatPrinciple('R1_1')` - Show the the \"Reusable\" sub-principle.\n\n```typescript\nimport chalk from 'chalk';\nimport { formatPrinciples } from 'fair-principles';\n\nconsole.log(formatPrinciples('A*', { chalk }));\n```\n\n## highlightFAIR\n\nHighlights the word FAIR with a specific color, for example, with an underline or in red (the default).\n\n```typescript\nimport chalk from 'chalk';\nimport { highlightFAIR } from 'fair-principles';\n\nhighlightFAIR('A', { color: chalk.underline });\n```\n\n## Format Options\n\nAll format calls can take `chalk` as an argument, this will apply defaults. You can also specify:\n\n- `indent`: (`boolean`): Indent sub-principles (for example `A1_1`), default is `true`\n- `showTitle`: (`boolean`): Shows the title \"FAIR Principles\"\n- `showHeader`: (`boolean`): Show a header like \"Accessible\" before the \"A\" principle\n- `title`: (`Formatter`): A color formatter for the title\n- `header`: (`Formatter`): A color formatter for the header\n- `enumerator`: (`Formatter`): A color formatter for the enumerator (e.g. `A1`)\n\n---\n\nAs of v2.0.0 this package is [ESM only](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c).\n\n---\n\n\u003cp style=\"text-align: center; color: #aaa; padding-top: 50px\"\u003e\n  Made with love by\n  \u003ca href=\"https://continuous.foundation\" target=\"_blank\" style=\"color: #aaa\"\u003e\n    Continuous Science Foundation \u003cimg src=\"https://continuous.foundation/images/logo-small.svg\" style=\"height: 1em\" /\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcontinuous-foundation%2Ffair-principles","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcontinuous-foundation%2Ffair-principles","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcontinuous-foundation%2Ffair-principles/lists"}