https://github.com/continuous-foundation/credit-roles
A utility for validating CRT Contributor Roles (https://credit.niso.org/) in your application, building canonical URLS, and showing descriptions.
https://github.com/continuous-foundation/credit-roles
Last synced: 5 months ago
JSON representation
A utility for validating CRT Contributor Roles (https://credit.niso.org/) in your application, building canonical URLS, and showing descriptions.
- Host: GitHub
- URL: https://github.com/continuous-foundation/credit-roles
- Owner: continuous-foundation
- License: mit
- Created: 2023-01-01T21:51:06.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-11-29T22:41:15.000Z (over 1 year ago)
- Last Synced: 2025-10-19T09:55:21.964Z (8 months ago)
- Language: TypeScript
- Size: 410 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# credit-roles
[](https://www.npmjs.com/package/credit-roles)
[](https://github.com/continuous-foundation/credit-roles/blob/main/LICENSE)
> CRediT (Contributor Roles Taxonomy) is a high-level taxonomy, including 14 roles, that can be used to represent the roles typically played by contributors to research outputs. The roles describe each contributor’s specific contribution to the scholarly output. (https://credit.niso.org/)
A utility for validating [CRT Contributor Roles](https://credit.niso.org/) in your application, building canonical URLs, and showing descriptions.
```shell
npm install credit-roles
```
The library has **no dependencies**, and is helpful in validating, normalizing and showing descriptions of CRediT roles.
## Overview & Usage
```ts
import { credit, CreditRole, CreditDescriptions } from 'credit-roles';
// Validate that a string is a role
credit.validate('contributor'); // true
// Handles British spelling and capitalizations
credit.normalize('conceptualiSation'); // "Conceptualization"
// Handles different punctuation
credit.normalize('writing: original draft'); // "Writing – original draft"
// Show the descriptions in your application
CreditDescriptions['Supervision']; // Oversight and leadership responsibility...
// An enum for easy access to the roles
CreditRole.WritingOriginalDraft;
```
## Included Utilities
- `validate` - Validates if a string to a CRediT role if it is valid, will take URLs and unformatted strings
- `normalize` - Normalizes a CRediT string into the canonical string (including hyphens, capitalization and punctuation)
- `buildUrl` - Builds a URL to https://credit.niso.org, includes normalization
- `CreditRole` - an enum of the CRediT roles
- `CreditDescriptions` - Official descriptions of the CRediT roles by NISO
## Options
- `strict`: only accept normalized CRediT roles when validating or building URLs
## Alias
In addition to british english, incorrect case or punctuation, there are also a number of aliases that can be used for various roles:
| Alias | Official CRediT Role |
| -------------- | -------------------------- |
| writing | Writing – original draft |
| editing | Writing – review & editing |
| review | Writing – review & editing |
| analysis | Formal analysis |
| funding | Funding acquisition |
| admin | Project administration |
| administration | Project administration |
## References
- https://credit.niso.org/
- https://jats4r.org/credit-taxonomy
---
As of v2.0.0 this package is [ESM only](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c).
---
Made with love by
Continuous Science Foundation 