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

refactor: remove mustache in favour of handlebars #1455

Draft
wants to merge 42 commits into
base: dev
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
42 commits
Select commit Hold shift + click to select a range
9732350
refactor: renamed and removed mustache files
mfranzke Dec 25, 2022
82d79c2
refactor: changed mustache to handlebars extensions
mfranzke Dec 25, 2022
9132377
refactor: changed mustache to handlebars extensions
mfranzke Dec 25, 2022
f5f23d2
chore: removed mustache related test
mfranzke Dec 25, 2022
b37bd08
fix: corrected those path
mfranzke Dec 25, 2022
8c001e4
refactor: removed the mustache package dependency
mfranzke Dec 26, 2022
be893ac
chore: updated engine
mfranzke Dec 26, 2022
b991e02
chore: corrected the fileending
mfranzke Dec 26, 2022
cc913fa
refactor: adapted handlebars config and docs
mfranzke Dec 26, 2022
e6fb9cd
chore: adapted structure out of newer uikit
mfranzke Dec 26, 2022
014ea88
Merge branch 'dev' into 1239-deprecate-mustache-as-default-engine
mfranzke Dec 27, 2022
c30b78c
Merge branch 'dev' into 1239-deprecate-mustache-as-default-engine
JosefBredereck Dec 28, 2022
e4ff89e
Merge branch 'dev' into 1239-deprecate-mustache-as-default-engine
mfranzke Dec 30, 2022
98ce349
fix: incorrect path
mfranzke Dec 30, 2022
04a7c95
fix: incorrect path
mfranzke Dec 30, 2022
65b4690
fix: incorrect path
mfranzke Dec 30, 2022
74a3cad
fix: incorrect path
mfranzke Dec 30, 2022
8fb16eb
Merge branch 'dev' into 1239-deprecate-mustache-as-default-engine
mfranzke Dec 30, 2022
7f9fd5a
chore(CI/CD): let's not install mustache engine anymore
mfranzke Dec 30, 2022
fe8329c
refactor: need to switch to the handlebars engine
mfranzke Dec 30, 2022
4835d3b
refactor: switched to hbs fileextension in configurations
mfranzke Dec 30, 2022
c78ebc6
refactor: switching from mustache engine to handlebars
mfranzke Dec 30, 2022
30be5bc
refactor(docs): switching from mustache to handlebars
mfranzke Dec 30, 2022
2c318bd
test: switching from mustache to handlebars
mfranzke Dec 30, 2022
853a493
refactor: revert the workaround out of !1256
mfranzke Dec 30, 2022
560c7ec
Update pattern_engines.js
mfranzke Dec 31, 2022
59fbbf1
Merge branch '1239-deprecate-mustache-as-default-engine' of https://g…
mfranzke Jan 1, 2023
62240b1
Restore packages/core/test/engine_mustache_tests.js
mfranzke Jan 1, 2023
bd7dfd9
refactor(test): updated syntax to handlebars
mfranzke Jan 1, 2023
764d0f2
chore: set this explicitly, aligned with the others
mfranzke Jan 3, 2023
6a14990
Merge branch 'dev' into 1239-deprecate-mustache-as-default-engine
mfranzke Jan 3, 2023
82916a1
test: updated test case files
mfranzke Jan 4, 2023
b5a4426
test: we need to ignore our handlebars files that contain partials re…
mfranzke Jan 4, 2023
781f0b0
chore: simple comment
mfranzke Jan 4, 2023
054feb3
Merge branch 'dev' into 1239-deprecate-mustache-as-default-engine
mfranzke Jan 8, 2023
6839abd
Merge branch 'dev' into 1239-deprecate-mustache-as-default-engine
mfranzke Jan 9, 2023
03a16e9
Merge branch 'dev' into 1239-deprecate-mustache-as-default-engine
mfranzke Jan 14, 2023
8ccef04
Merge branch 'dev' into 1239-deprecate-mustache-as-default-engine
JosefBredereck Jan 30, 2023
8556478
Merge branch 'dev' into 1239-deprecate-mustache-as-default-engine
mfranzke Jan 31, 2023
d983139
Merge branch 'dev' into 1239-deprecate-mustache-as-default-engine
mfranzke Apr 1, 2023
f8bf5f1
refactor: removed expandPartials
mfranzke Apr 1, 2023
80eadf7
refactor: removed leftovers
mfranzke Apr 1, 2023
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
Prev Previous commit
Next Next commit
refactor(docs): switching from mustache to handlebars
  • Loading branch information
mfranzke committed Dec 30, 2022
commit 30be5bcdc07962876a532f9db5ce1affcde3063d
2 changes: 1 addition & 1 deletion packages/docs/src/docs/advanced-config-options.md
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@ Sets the configurable source and public directories for files Pattern Lab Node o

Sets the panel name and language for the code tab on the styleguide. Since this only accepts one value, this is a place where mixed pattern trees (different PatternEngines in the same instance of Pattern Lab) does not quite work.

**default**: `mustache`
**default**: `hbs`

## engines

Expand Down
2 changes: 1 addition & 1 deletion packages/docs/src/docs/advanced-ecosystem-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ UIKits are the front-end of Pattern Lab. We call this “The Viewer.” UIKits a

### PatternEngines

PatternEngines are the templating engines that are responsible for parsing patterns and turning them into HTML. PatternEngines give Pattern Lab Core the flexibility to render many different types of template languages. Current PatternEngines include Mustache and Twig, with others like Handlebars and Underscore in development. And there’s no stopping you from adding another templating engine to Pattern Lab.
PatternEngines are the templating engines that are responsible for parsing patterns and turning them into HTML. PatternEngines give Pattern Lab Core the flexibility to render many different types of template languages. Current PatternEngines include Handlebars and Twig, with others like React and Underscore in development. And there’s no stopping you from adding another templating engine to Pattern Lab.

### Plugins

Expand Down
2 changes: 1 addition & 1 deletion packages/docs/src/docs/advanced-keyboard-shortcuts.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Modifying the views:
- **ctrl+shift+a**: open/close info panels
- **ctrl+shift+c**: open/close info panels
- **cmd+a/ctrl+a**: select the content of the current open tab in code view
- **ctrl+shift+u**: make the Mustache tab active
- **ctrl+shift+u**: make the Handlebars tab active
- **ctrl+shift+y**: make the HTML tab active
- **esc**: close the open view

Expand Down
4 changes: 2 additions & 2 deletions packages/docs/src/docs/advanced-starterkits.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,8 @@ where [starterkit-name] is the name of the Starterkit.
so... a complete example:

```
npm install @pattern-lab/starterkit-mustache-demo
gulp patternlab:loadstarterkit --kit=@pattern-lab/starterkit-mustache-demo
npm install @pattern-lab/starterkit-handlebars-demo
gulp patternlab:loadstarterkit --kit=@pattern-lab/starterkit-handlebars-demo
```

The [Pattern Lab Node CLI](https://github.com/pattern-lab/patternlab-node/tree/master/packages/cli) will also support installation of Starterkits should you not be using gulp.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ eleventyNavigation:
sitemapPriority: '0.8'
---

By default Pattern Lab uses the Mustache template language, extended with [pattern parameters](/docs/using-pattern-parameters/). PatternEngines let you add support for a template language of your personal choice. Each PatternEngine has it's own set of features and caveats.
By default Pattern Lab uses the Handlebars template language, extended with [pattern parameters](/docs/using-pattern-parameters/). PatternEngines let you add support for a template language of your personal choice. Each PatternEngine has it's own set of features and caveats.

Right now the most mature PatternEngines are Handlebars, Mustache and Twig.
Right now the most mature PatternEngines are Handlebars and Twig.

## Official PatternEngines for Node

Expand Down
2 changes: 1 addition & 1 deletion packages/docs/src/docs/pattern-pseudo-patterns.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ From a navigation and naming perspective `patternName` and `pseudoPatternName` w

## Adding Pseudo-Patterns to Your Project

Adding a pseudo-pattern is as simple as naming it correctly and following the [pattern-specific JSON file](/docs/creating-pattern-specific-values/) instructions for organizing its content. Let's look at a simple example where we want to show an emergency notification on our homepage Mustache template. Our `templates/` directory might look like this:
Adding a pseudo-pattern is as simple as naming it correctly and following the [pattern-specific JSON file](/docs/creating-pattern-specific-values/) instructions for organizing its content. Let's look at a simple example where we want to show an emergency notification on our homepage Handlebars template. Our `templates/` directory might look like this:

article.hbs
blog.hbs
Expand Down
2 changes: 1 addition & 1 deletion packages/starterkit-twig-demo/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

# Demo StarterKit for Twig

The Demo StarterKit for Twig is meant to be used as a demo that highlights how to combine Twig and Pattern Lab. It is currently very thin. We're looking for maintainers who may be interested in making this demo the equal to if not better than the Mustache demo.
The Demo StarterKit for Twig is meant to be used as a demo that highlights how to combine Twig and Pattern Lab. It is currently very thin. We're looking for maintainers who may be interested in making this demo the equal to if not better than the Handlebars demo.

## Requirements

Expand Down