https://github.com/pulseflow/petal

A collection of wrappers and coding guidelines we use @ PulseFlow
https://github.com/pulseflow/petal

Last synced: 5 months ago
JSON representation

A collection of wrappers and coding guidelines we use @ PulseFlow

• Host: GitHub
• URL: https://github.com/pulseflow/petal
• Owner: pulseflow
• License: apache-2.0
• Created: 2023-03-12T23:50:38.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-12-30T00:45:22.000Z (5 months ago)
• Last Synced: 2024-12-31T14:46:17.125Z (5 months ago)
• Language: TypeScript
• Size: 3.15 MB
• Stars: 2
• Watchers: 0
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: changelogithub.config.json
  • License: LICENSE-APACHE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# @flowr/petal

[![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)

## 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/fetch`](./packages/fetch): Small wrapper around `globalThis.fetch` for improved TypeScript and data support

- [`@flowr/iterator`](./packages/iterator): Opinionated collection of common iterator utilities

- [`@flowr/loader`](./packages/loader): A simple TypeScript code piece loader

- [`@flowr/metadata`](./packages/metadata): Useful TypeScript decorators for Petal projects

- [`@flowr/node`](./packages/node): Node-specific opinionated TypeScript utilities

- [`@flowr/result`](./packages/result): A TypeScript port of Rust's `Result` and `Option` structs

- [`@flowr/store`](./packages/store): 

- [`@flowr/types`](./packages/types): Essential TypeScript type utilities used in `@flowr/utilities`

- [`@flowr/typescript`](./packages/typescript): A collection of different base `tsconfig.json` to be extended from in your project.

- [`@flowr/utilities`](./packages/utilities): Opinionated collection of common TypeScript utilities

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

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`.