Skip to content

Conversation

@joewiz
Copy link
Member

@joewiz joewiz commented Jun 25, 2024

Minimally incorporates the following suggestion from eeditiones/tei-publisher-app#194:

File extensions: For file extensions, use the .xq file extension for main modules and .xqm for library modules.

… but ONLY at jinks top-level application package - not for any of the generated application packages.

(Note to self: Look into whether it's possible to create a profile that could apply the convention to legacy apps... and thereby hopefully facilitate adoption of the community convention.)

Update (2025-11-05): As noted below, I've added a commit applying the change across the app, not just the top-level package.

@joewiz joewiz force-pushed the adopt-community-convention branch from af97d15 to d0787be Compare July 23, 2024 14:11
@joewiz joewiz force-pushed the adopt-community-convention branch 2 times, most recently from bb71948 to 1b75cb4 Compare November 5, 2025 16:21
@joewiz
Copy link
Member Author

joewiz commented Nov 5, 2025

I have rebased this PR. Already, I think the way the PR clarifies the nature of the main modules (like api.xq) vs. library modules (like config.xqm) is helpful.

I'm wondering whether TP10 would be a good time to apply this change to the rest of the repository - i.e., to all generated apps too. I assume everyone will be touching every piece of code to adapt to TP10 anyway, so this might be the least disruptive time to adjust the project's file extension conventions. To TP-generated app maintainers, this would also signal whether an app is of the 10 era or pre-10 era.

… ONLY at jinks top-level application package - not for any of the generated application packages
@joewiz joewiz force-pushed the adopt-community-convention branch from 1b75cb4 to e85623c Compare November 5, 2025 17:02
extend community convention for XQuery modules to all files in Jinks
@joewiz joewiz force-pushed the adopt-community-convention branch from e85623c to 7b54c95 Compare November 5, 2025 17:16
@joewiz joewiz marked this pull request as draft November 5, 2025 17:18
@joewiz joewiz marked this pull request as ready for review November 5, 2025 18:10
@joewiz
Copy link
Member Author

joewiz commented Nov 5, 2025

I added a 2nd commit applying the community convention to all files across the repository. CI tests pass.

IF (that's a big "if") you are interested in this expanded PR, I would happily add a commit to the PR updating the documentation to reflect the new convention and add a section describing the change for users updating.

@joewiz
Copy link
Member Author

joewiz commented Nov 5, 2025

I performed a directory diff comparison of a documentation app generated before and after this PR and confirmed (1) that the app generated with the PR works normally and (2) the only changes are to the XQuery module filenames and references thereto.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant