{"id":20947208,"url":"https://github.com/fairdataihub/config","last_synced_at":"2025-05-14T01:32:02.629Z","repository":{"id":41432671,"uuid":"509559791","full_name":"fairdataihub/config","owner":"fairdataihub","description":"Commonly used configs for FAIR Data Innovations Hub projects","archived":false,"fork":false,"pushed_at":"2024-11-07T18:58:34.000Z","size":1540,"stargazers_count":1,"open_issues_count":10,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-11-07T19:44:59.352Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/@fairdataihub/config","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/fairdataihub.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-07-01T18:53:35.000Z","updated_at":"2024-10-29T17:02:11.000Z","dependencies_parsed_at":"2024-03-07T18:47:46.921Z","dependency_job_id":"7afb282a-3200-4750-b22a-c936aabba632","html_url":"https://github.com/fairdataihub/config","commit_stats":{"total_commits":132,"total_committers":6,"mean_commits":22.0,"dds":0.5909090909090908,"last_synced_commit":"163cf277f80b953768e63f95834b87836f32c2b3"},"previous_names":[],"tags_count":17,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fairdataihub%2Fconfig","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fairdataihub%2Fconfig/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fairdataihub%2Fconfig/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fairdataihub%2Fconfig/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fairdataihub","download_url":"https://codeload.github.com/fairdataihub/config/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225191625,"owners_count":17435578,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":"2024-11-19T00:09:56.453Z","updated_at":"2024-11-19T00:09:57.036Z","avatar_url":"https://github.com/fairdataihub.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# @fairdataihub/config\n\n![NPM](https://img.shields.io/npm/l/@fairdataihub/config)\n![NPM](https://img.shields.io/npm/v/@fairdataihub/config)\n![GitHub Workflow Status](https://github.com/fairdataihub/config/actions/workflows/release.yml/badge.svg?branch=main)\n\nA simple list of configs for use in [FAIR Data Innovations Hub](https://github.com/fairdataihub) projects.\n\n```\nnpm install --save-dev @fairdataihub/config\nyarn add -D @fairdataihub/config\n```\n\n## How to use\n\nRefer to our documentation for this package here: [@fairdataihub/config](https://dev.fairdataihub.org/general/config.html)\n\n## Getting started\n\n1. `git clone https://github.com/fairdataihub/config.git `\n2. `cd config`\n3. `npm install`\n\nTo enable deployment, you will need to:\n\n1. Setup `NPM_TOKEN` secret in GitHub actions ([Settings \u003e Secrets \u003e Actions](https://github.com/fairdataihub/config/settings/secrets/actions))\n2. Give `GITHUB_TOKEN` write permissions for GitHub releases ([Settings \u003e Actions \u003e General](https://github.com/fairdataihub/config/settings/actions) \u003e Workflow permissions)\n\n## Features\n\nCurrently supported configs:\n\n- prettier\n- eslint\n- devmoji\n- commitlint\n\n### Typescript\n\nLeverages [esbuild](https://github.com/evanw/esbuild) for blazing fast builds, but keeps `tsc` to generate `.d.ts` files.\nGenerates two builds to support both ESM and CJS.\n\nCommands:\n\n- `build`: runs typechecking then generates CJS, ESM and `d.ts` files in the `build/` directory\n- `clean`: removes the `build/` directory\n- `type:dts`: only generates `d.ts`\n- `type:check`: only run typechecking\n- `type:build`: only generates CJS and ESM\n\n### Tests\n\nThis library uses [ava](https://github.com/avajs/ava) and [esbuild-register](https://github.com/egoist/esbuild-register) so that there is no need to compile before the tests start running. The coverage is done through [nyc](https://github.com/istanbuljs/nyc).\n\nCommands:\n\n- `test`: runs ava test runner\n- `test:coverage`: runs ava test runner and generates coverage reports\n\n### Format \u0026 lint\n\nThis project relies on the combination of [eslint](https://github.com/eslint/eslint) — through [typescript-eslint](https://github.com/typescript-eslint/typescript-eslint) for linting and [prettier](https://github.com/prettier/prettier) for formatting.\nIt also uses [cspell](https://github.com/streetsidesoftware/cspell) to ensure spelling\n\nCommands:\n\n- `format`: runs prettier with automatic fixing\n- `format:check`: runs prettier without automatic fixing (used in CI)\n- `lint`: runs eslint with automatic fixing\n- `lint:check`: runs eslint without automatic fixing (used in CI)\n- `spell:check`: runs spellchecking\n\n### Releasing\n\nUnder the hood, this library uses [semantic-release](https://github.com/semantic-release/semantic-release) and [commitizen](https://github.com/commitizen/cz-cli).\nThe goal is to avoid manual release process. Using `semantic-release` will automatically create a github release (hence tags) as well as an npm release.\nBased on your commit history, `semantic-release` will automatically create a patch, feature or breaking release.\n\nCommands:\n\n- `cz`: interactive CLI that helps you generate a proper git commit message, using [commitizen](https://github.com/commitizen/cz-cli)\n- `semantic-release`: triggers a release (used in CI)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffairdataihub%2Fconfig","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffairdataihub%2Fconfig","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffairdataihub%2Fconfig/lists"}