Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/publicodes/tools
Set of utility functions to write tooling for Publicodes models
https://github.com/publicodes/tools
compilation optimization publicodes utility-library
Last synced: about 2 months ago
JSON representation
Set of utility functions to write tooling for Publicodes models
- Host: GitHub
- URL: https://github.com/publicodes/tools
- Owner: publicodes
- License: mit
- Created: 2023-01-12T14:01:48.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-24T18:46:31.000Z (8 months ago)
- Last Synced: 2024-05-02T03:14:21.258Z (8 months ago)
- Topics: compilation, optimization, publicodes, utility-library
- Language: TypeScript
- Homepage: https://publicodes.github.io/tools/
- Size: 1.63 MB
- Stars: 7
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
@publicodes/tools
Report Bug
âĒ
API docs
âĒ
Contribute
âĒ
Publicodes
![CI][ci-link] ![NPM][npm-link]
Set of utility functions that could be used to easily write tooling around [Publicodes](https://publi.codes) models.
:warning: The project is not stable yet, don't hesitate [to open an issue](https://github.com/publicodes/tools/issues) if you face a problem! :warning:
## Features
- ðïļ Compiles your set of Publicodes files into a standalone JSON file - [[doc](https://publicodes.github.io/tools/modules/compilation.html#md:compile-a-model-from-a-source)]
- ðĶ Resolves import from external Publicodes models, from source and from published [NPM packages](https://www.npmjs.com/package/futureco-data) - [[doc](https://publicodes.github.io/tools/modules/compilation.html#md:import-rules-from-a-npm-package)]
- ðŠķ Pre-computes your model at compile time and reduces [the number of rules by ~65%](https://github.com/incubateur-ademe/nosgestesclimat/pull/1697) - [[doc](https://publicodes.github.io/tools/modules/optims.html)]
- âĄïļ Use a migration function for user situation to deal with breaking changes in your models - [[doc](https://publicodes.github.io/tools/modules/migration.html)]## Installation
```
npm install --dev-dependency @publicodes/toolsyarn add -D @publicodes/tools
```## Usage in local
When developing in local:
1. you can link the local package with `yarn link`,
2. launch the compilation in watch mode with `yarn watch`,
3. and use it in your project with `yarn link @publicodes/tools`.[ci-link]: https://img.shields.io/github/actions/workflow/status/publicodes/tools/build.yml?logo=github&logoColor=white&label=build%20%26%20test
[npm-link]: https://img.shields.io/npm/v/%40publicodes%2Ftools?logo=npm&logoColor=white&color=%23185dae