https://github.com/thefrontside/effectionx
Useful collection of community contributed modules for Effection
https://github.com/thefrontside/effectionx
Last synced: 6 months ago
JSON representation
Useful collection of community contributed modules for Effection
- Host: GitHub
- URL: https://github.com/thefrontside/effectionx
- Owner: thefrontside
- License: mit
- Created: 2024-09-13T21:11:14.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-04-14T18:16:55.000Z (about 1 year ago)
- Last Synced: 2025-04-14T23:43:49.825Z (about 1 year ago)
- Language: TypeScript
- Homepage: https://frontside.com/effection/contrib
- Size: 303 KB
- Stars: 7
- Watchers: 2
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# effectionx
This repository contains a collection of contributions by the community. This
repository automatically publishes to JSR and NPM. All packages that were used
more than a few times are welcome.
## Adding a new package
1. Create a directory
2. Add a deno.json file with
`{ "name": "@effectionx/", version: "0.1.0", "exports": "./mod.ts", "license": "MIT" }`
3. Add a README.md (text before `---` will be used as a description for the
package)
4. Add your source code and export it from `mod.ts`
5. Add doc strings to your source code - they will be used for documentation on
the site.
## Testing
All packages are tested against both effection v3 and v4 to ensure
compatibility.
### Generate import maps
```bash
# Generate v3 import map
deno task generate-importmap "^3" v3.importmap.json
# Generate v4 import map (fetches latest v4 from npm)
deno task generate-importmap v4 v4.importmap.json
```
### Running tests with v3
```bash
deno test --import-map v3.importmap.json -A
```
### Running tests with v4
```bash
deno test --import-map v4.importmap.json -A
```
## To publish a new project
1. Member of [jsr.io/@effectionx](https://jsr.io/@effectionx) has to add that
project to the scope
2. It should be publish on next merge to main