Skip to content

feat: Pug-to-Handlebars Pipeline #501

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.

Sign up for GitHub

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

Open
wyrmisis wants to merge 7 commits into
base: main
Choose a base branch
from
Open

feat: Pug-to-Handlebars Pipeline #501

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
859d655
fix: Add human readable labels to document types
wyrmisis Feb 16, 2024
a488739
fix: Deprecated data model assignment method
wyrmisis Feb 16, 2024
9643082
chore: while I'm here... begone, mprocs!
wyrmisis Feb 16, 2024
d5a5534
feat: Pug-to-Handlebars pipeline
wyrmisis Feb 16, 2024
116357f
fix: make rollup config a module
wyrmisis Feb 16, 2024
11abbe8
feat: an example of Pug in action
wyrmisis Feb 16, 2024
a937bbf
chore: Update contributing docs to reference build and code quality t…
wyrmisis Feb 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@ foundryconfig.json
dist
.DS_Store
.env
mprocs.yaml
Copy link
Collaborator Author

@wyrmisis wyrmisis Feb 16, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I figured, while I'm in here, I might as well ignore the config script for the tool I use to run dev and Foundry from one terminal window.

10 changes: 9 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ This guide should help you get the UFT development environment completely

### Developer Environment Installation

Prerequisites: Node.js (v16 is recommended), a familiarity with command Foundry VTT with a valid license
Prerequisites: Node.js (v16 is recommended), a familiarity with command line, Foundry VTT with a valid license

[Node installers (beginner-friendly)](https://nodejs.org/en/download/)
[Node on package managers (recommended, I use nvm)](https://nodejs.org/en/download/package-manager/#windows)
Expand All @@ -93,6 +93,14 @@ Prerequisites: Node.js (v16 is recommended), a familiarity with command Foundry
1. In your command line, run `npm run link`. A new system should now appear in your systems directory (or directories) but it doesn't yet run any code.
1. In your command line, run `npm run build` (build once) or `npm run build:watch` (build continuously, whenever a change is saved). You now have a working copy of OSE's developer build. You should be able to install releases of `ose` alongside this build.

### Our Tools in Brief
- We use [Rollup](https://rollupjs.org/introduction/) to bundle our Typescript and Javascript
- We use [SCSS](https://sass-lang.com/documentation/syntax/) for the bulk of our stylesheets
- We use [Pug](https://pugjs.org/api/getting-started.html) as a pre-processor for our Handlebars templates.
- We ensure code quality through tools like:
- [ESLint](https://eslint.org/docs/latest/use/core-concepts) and [Prettier](https://prettier.io/docs/en/why-prettier) for enforcing coding style.
- [Quench](https://github.com/Ethaks/FVTT-Quench) for running automated tests.

### Addendum: Git for Beginners

Many contributors to Unofficial OSE on Foundry VTT are inexperienced with git. GitHub provides their [quickstart tutorial](https://docs.github.com/en/get-started/quickstart/hello-world) which we recommend as a first step toward becoming an OSE Contributor.
Expand Down
Loading