53 lines
3.4 KiB
Markdown
53 lines
3.4 KiB
Markdown
|
# @pushrocks/smarthbs
|
||
|
|
handlebars with better fs support
|
||
|
|
|
||
|
|
## Availabililty and Links
|
||
|
|
* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smarthbs)
|
||
|
|
* [gitlab.com (source)](https://gitlab.com/pushrocks/smarthbs)
|
||
|
|
* [github.com (source mirror)](https://github.com/pushrocks/smarthbs)
|
||
|
|
* [docs (typedoc)](https://pushrocks.gitlab.io/smarthbs/)
|
||
|
|
|
||
|
|
## Status for master
|
||
|
|
|
||
|
|
Status Category | Status Badge
|
||
|
|
-- | --
|
||
|
|
GitLab Pipelines | [](https://lossless.cloud)
|
||
|
|
GitLab Pipline Test Coverage | [](https://lossless.cloud)
|
||
|
|
npm | [](https://lossless.cloud)
|
||
|
|
Snyk | [](https://lossless.cloud)
|
||
|
|
TypeScript Support | [](https://lossless.cloud)
|
||
|
|
node Support | [](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
||
|
|
Code Style | [](https://lossless.cloud)
|
||
|
|
PackagePhobia (total standalone install weight) | [](https://lossless.cloud)
|
||
|
|
PackagePhobia (package size on registry) | [](https://lossless.cloud)
|
||
|
|
BundlePhobia (total size when bundled) | [](https://lossless.cloud)
|
||
|
|
Platform support | [](https://lossless.cloud) [](https://lossless.cloud)
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
> Note: Why did we decide against a class based architecture?
|
||
|
|
> Easy: handlebars.js is already pretty determined how things are handled internally, namely a global partial template registry
|
||
|
|
> It doesn't make sense to then introduce a scoped partial template approach.
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
import * as smarthbs from 'smarthbs';
|
||
|
|
|
||
|
|
// read all .hbs files in a directory and any child directories and use relative path as partial string identifier
|
||
|
|
smarthbs.registerPartialDir(testPartialDir);
|
||
|
|
|
||
|
|
// read all .hbs files in a particular directory and level, output them to a destination and specify a .json file to read any referenced data
|
||
|
|
smarthbs.compileDirectory(testHbsDir, testResultDir, 'data.json');
|
||
|
|
```
|
||
|
|
|
||
|
|
|
||
|
|
## Contribution
|
||
|
|
|
||
|
|
We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
|
||
|
|
|
||
|
|
For further information read the linked docs at the top of this readme.
|
||
|
|
|
||
|
|
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
||
|
|
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
|
||
|
|
|
||
|
|
[](https://maintainedby.lossless.com)
|