Generate citation strings from citation.cff file as part of build process

[cherriechang]

No description provided.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 5b64a47

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[bjoluc]

@jodeleeuw When you updated the dependencies, including esbuild from 0.15.14 to 0.23.1 in 59ce0b3, did you read the changelogs? There seem to be a lot of breaking changes in esbuild and we need to be confident that they are not breaking for @jspsych/config users (unless you are planning to release a config v4 for any other reason 🤔 ). I didn't get suspicious about this earlier because your commit message didn't make it clear to me that you were updating dependencies 🙈

[bjoluc]

When I last checked a few months ago, NPM did only respect overrides defined in the root package.json. Did that change in a recent NPM version? If so, we still can't rely on it until we require the new version...

[bjoluc]

esbuild has a define option to specify code replacements. I think we should be using that instead of a custom rollup plugin to keep it simple.

[bjoluc]

@jodeleeuw I double-checked and committed the rollup dependency updates in #3396 – they're all welcome and independent of the .json issue. Re that issue: Because we are using esbuild via the rollup plugin, the final bundling is performed by rollup. esbuild never sees @citation-js/core/package.json, hence can't run its JSON loader on it. Your workaround with the additional Rollup JSON loader is good for now, although the more desirable solution might be to inline the version string right in the citation-js build (like most other packages do too). I'm too busy to contribute there ATM though 😕

[jodeleeuw]

@bjoluc just FYI, we ended up solving this by using @rollup/plugin-replace. We explored the esbuild define, but it required adding some declare const statements at the top of the plugin ts templates and that felt unnecessarily confusing for rookie devs.

[bjoluc]

but it required adding some declare const statements at the top of the plugin ts templates and that felt unnecessarily confusing for rookie devs.

Have you thought about declaring the constants globally in a .d.ts file in @jspsych/config, referenced by the exported tsconfigs?

Also, what about replacing a single __CITATIONS__ object? That would allow to add other formats at a later point without changing all the plugins, while further reducing boilerplate.

[jodeleeuw]

Have you thought about declaring the constants globally in a .d.ts file in @jspsych/config, referenced by the exported tsconfigs?

For some reason I thought this kind of strategy wouldn't work, but can't reconstruct my reasoning now. We can explore it!

Also, what about replacing a single CITATIONS object? That would allow to add other formats at a later point without changing all the plugins, while further reducing boilerplate.

This was something that crossed my mind. I was thinking that the current boilerplate makes it easier for someone building with the JS template to modify because they won't have to know the syntax, but then again we could just have a different template for plugins that aren't going to go through the build process. So that does seem better.

[jodeleeuw]

@cherriechang I'd like to get this merged soon. We need some docs still I think.

@jadeddelta we could also include the CFF files in the v8 update for the contrib repo?