Skip to content

Commit

Permalink
🐛 fix(package): fixes
Browse files Browse the repository at this point in the history
Signed-off-by: Pauline <git@ethanlibs.co>
  • Loading branch information
pauliesnug committed Nov 20, 2024
1 parent 7f8852c commit 40fd3cc
Show file tree
Hide file tree
Showing 6 changed files with 1,080 additions and 137 deletions.
38 changes: 15 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,36 +3,28 @@
[![Actions Status](https://github.com/pulseflow/petal/workflows/Tests/badge.svg)](https://github.com/pulseflow/petal/actions)
[![Version](https://img.shields.io/npm/v/@flowr/utilities.svg)](https://www.npmjs.com/package/@flowr/utilities)

A monorepo of configs and packages used to speed up development @ Pulseflow and ensure adherence to Petal standards.

## Petal Configuration Suite
## Packages

- [`create-petal`](./packages/create-petal): A CLI utility to create a new Petal app
- [`@flowr/crypto`](./packages/crypto):
- [`@flowr/eslint`](./packages/eslint): Standardized Petal specification linting configuration
- [`eslint-plugin-petal`](./packages/eslint-plugin): Custom ESLint rules for the Petal specification
- [`@flowr/typescript`](./packages/typescript): Common TSConfigs in Petal standardized projects

## Petal Utilities

- [`create-petal`](./packages/create-petal): WIP CLI utility for creating and migrating Petal projects
- [`@flowr/console`](./packages/console): WIP Utilities for logging with JavaScript.
- [`@flowr/utilities`](./packages/utilities): Universal utilities for Petal projects.
- [`@flowr/fetch`](./packages/fetch): Small wrapper around `globalThis.fetch` for improved TypeScript and data support
- [`@flowr/iterator`](./packages/iterator):
- [`@flowr/loader`](./packages/loader):
- [`@flowr/metadata`](./packages/metadata):
- [`@flowr/node`](./packages/node):
- [`@flowr/result`](./packages/result):
- [`@flowr/store`](./packages/store):
- [`@flowr/types`](./packages/types):
- [`@flowr/typescript`](./packages/typescript):
- [`@flowr/utilities`](./packages/utilities):

## Related projects we use
### Minimum Supported [Node.js](https://nodejs.org/) Version (MSNV)

- [TypeScript]: a superset of JavaScript which we think helps make code readable and less bug-prone.
- [ESLint]: used for static code analysis with auto-fixing.
- [Vitest]: our preferred JavaScript test framework.

### Minimum Supported [Node] Version (MSNV)

For those using the Node runtime, the current minimum version for usage and development is [v20.11.0](https://github.com/nodejs/node/releases/tag/v20.11.0).
The current minimum version for usage and development is [v22.11.0](https://github.com/nodejs/node/releases/tag/v22.11.0), with Node.js 22 ('Jod') LTS being recommended.

### TODO

- [ ] Use [`magic-regexp`](https://regexp.dev).
- [ ] Look into `@eslint/markdown`, `@eslint/css`, and `@eslint/json`.

[ESLint]: https://eslint.org/
[TypeScript]: https://www.typescriptlang.org/
[Vitest]: https://vitest.dev/
[Node]: https://nodejs.org/
2 changes: 1 addition & 1 deletion packages/create-petal/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"name": "create-petal",
"type": "module",
"version": "4.4.1",
"description": "A CLI utility to create a new petal app",
"description": "A CLI utility to create a new Petal app",
"author": "@flowr",
"contributors": ["Pauline <git@ethanlibs.co>"],
"license": "(LicenseRef-OQL-1.2 OR MIT OR Apache-2.0)",
Expand Down
Loading

0 comments on commit 40fd3cc

Please sign in to comment.