Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Distribute as an ES Module? #46

Open
steveszc opened this issue Mar 3, 2023 · 2 comments
Open

Distribute as an ES Module? #46

steveszc opened this issue Mar 3, 2023 · 2 comments
Labels
enhancement New feature or request

Comments

@steveszc
Copy link

steveszc commented Mar 3, 2023

Ahoy 👋

This repo has been enormously helpful to me as I built https://www.catechesis.app/, so thanks!
(repo here: https://github.com/steveszc/catechesis)

Catechesis is a single-page web app built with Ember.js and written in typescript.
Since I was working in typescript with npm/webpack I ended up copying most of the catechism data and converting it into JS POJOs that could be typed with typescript and imported as ES modules directly in my TS app. I also had to make some additions and alterations to the schema to support things like catechism question commentaries, audio, and prayers.

Long story short, even though I essentially hard-forked the data from this repo, I think I'd benefit a lot from being able to directly depend on this package. And if I was able to depend on it directly I could help maintain it, make improvements, etc.

But there's a decent amount of work to get the existing json into a format that could be published to NPM and consumed in a project like mine. I'm wondering if you have any interest in pursing this, or if you have any thoughts on how best to enable projects in the JS/npm ecosystem to use the work you've done here.

@NonlinearFruit
Copy link
Owner

Nice! Thanks for the feedback! I added Catechesis to the list of resources in the readme. I see two interesting ideas here. We'll use this issue for the first and #47 for the second.

  1. Packaging Creeds.json. I'm definitely open to distributing the public domain resources as a package. It would be awesome to publish these to all sorts of registries (I hadn't thought of that). Two caveats is that we'd want to stay as language neutral as possible (I've love to publish packages to multiple repositories) and I don't have permission to distribute some of the content here, so we'd only be able to publish public domain works.

  2. The other idea that is interesting is using Typescript. That could more easily enforce the schema and make writing tests a lot easier 🤔

@NonlinearFruit NonlinearFruit added the enhancement New feature or request label Mar 3, 2023
@NonlinearFruit NonlinearFruit changed the title Hello + Improvements for JS usage Distribute as an ES Module? Mar 3, 2023
@NonlinearFruit
Copy link
Owner

if you have any thoughts on how best to enable projects in the JS/npm ecosystem to use the work you've done here.

@steveszc The tests are now in TypeScript with type definitions (source), if that is helpful. Were there any specific problems using the data in JS?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants