https://github.com/hjonin/codemeta-tools

codemeta.json tool repository
https://github.com/hjonin/codemeta-tools

Last synced: 2 days ago
JSON representation

codemeta.json tool repository

• Host: GitHub
• URL: https://github.com/hjonin/codemeta-tools
• Owner: hjonin
• License: agpl-3.0
• Created: 2024-07-18T14:28:11.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-10-07T15:58:59.000Z (about 1 month ago)
• Last Synced: 2024-11-09T04:40:00.070Z (5 days ago)
• Language: TypeScript
• Homepage:
• Size: 403 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/hjonin/codemeta-tools/ci.yml?label=Tests)

# codemeta-tools

A set of tools to support the creation of metadata files (including but not limited to `codemeta.json` files) for software.

## Installation

### Node.js (>= 18) + npm

```bash

npm install codemeta-tools

```

```javascript

import {validate} from "codemeta-tools";

validate({

    "@context": "https://w3id.org/codemeta/3.0",

    "type": "SoftwareSourceCode",

    "license": "https://spdx.org/licenses/AGPL-3.0-or-later",

    "name": "codemeta-tools"

});

```

### Browser bundle

The npm package includes bundled code in `./dist/codemeta-tools.bundle.js` which can be loaded as an ES Module.

You can also load it using [jsDelivr](https://www.jsdelivr.com/) CDN, like in the example below.

```html

  

  Title

  import {

    validate

  } from "https://cdn.jsdelivr.net/npm/codemeta-tools@[VERSION]/dist/codemeta-tools.bundle.js/+esm";

  validate(/* {...} */)

```

## Run locally

Install dependencies:

```bash

npm install

```

Run tests:

```bash

npm run test 

```

Publish:

```bash

npm version [version]

npm publish

```

## Contributing

Contributions are always welcome!

There is a [list of issues](https://github.com/hjonin/codemeta-tools/issues) related to this repository, some of them labeled as [good first issues](https://github.com/hjonin/codemeta-tools/contribute).

## Authors

- [@hjonin](https://github.com/hjonin)

## License

[AGPL-3.0-or-later](LICENSE)