https://github.com/azu/lodash-template-js-parser
A JavaScript parser for `lodash.template`.
https://github.com/azu/lodash-template-js-parser
javascript lodash parser splitter template
Last synced: 6 months ago
JSON representation
A JavaScript parser for `lodash.template`.
- Host: GitHub
- URL: https://github.com/azu/lodash-template-js-parser
- Owner: azu
- License: mit
- Created: 2019-10-25T10:25:01.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-10-30T07:10:11.000Z (over 6 years ago)
- Last Synced: 2025-06-23T23:48:55.138Z (8 months ago)
- Topics: javascript, lodash, parser, splitter, template
- Language: TypeScript
- Homepage:
- Size: 60.5 KB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# lodash-template-js-parser [](https://travis-ci.org/azu/lodash-template-js-parser)
A JavaScript parser/splitter for [`lodash.template`](https://lodash.com/docs/#template)
## Features
- It separate JavaScript Code and Template String from `lodash.template` content
- Preserve same position of JavaScript code as possible
> Lodash template -> JavaScript Code and Template Content.
It help to implement lint tools for JavaScript code in lodash template.
This idea and implementation is based on [ota-meshi/eslint-plugin-lodash-template](https://github.com/ota-meshi/eslint-plugin-lodash-template).
## Motivation
[ota-meshi/eslint-plugin-lodash-template](https://github.com/ota-meshi/eslint-plugin-lodash-template) focus on linting by ESLint, so It includes many features.
I want to get simple parser/splitter for lodash template.
`lodash-template-js-parser` just includes a parser for lodash template, So `lodash-template-js-parser` does not includes JavaScript Parser like espree, babel/parser.
## Install
Install with [npm](https://www.npmjs.com/):
npm install lodash-template-js-parser
## Usage
```ts
export interface parseTemplateOptions {
templateSettings?: {
escape?: [string, string];
evaluate?: [string, string];
interpolate?: [string, string];
};
}
/**
* Parse the template and return { script, template } object.
* @param code The template to parse.
* @param parserOptions The parser options.
* @returns The parsing result object.
*/
export declare function parseTemplate(template: string, parserOptions: parseTemplateOptions): {
script: string;
template: string;
};
```
Example:
```js
import { parseTemplate } from "lodash-template-js-parser";
const content = `
const age = 18;
<% if (age < 18) { %>
<% } else { %>
<% }%>
`;
const { script, template } = parseTemplate(content, {
templateSettings: {
interpolate: ["#{", "}"]
}
});
assert.strictEqual(script, `
if (age < 18) {
name ; age ;
} else {
}
`);
assert.strictEqual(template, `
const age = 18;
`);
```
## Changelog
See [Releases page](https://github.com/azu/lodash-template-js-parser/releases).
## Running tests
Install devDependencies and Run `npm test`:
npm test
## Contributing
Pull requests and stars are always welcome.
For bugs and feature requests, [please create an issue](https://github.com/azu/lodash-template-js-parser/issues).
1. Fork it!
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request :D
## Author
- [github/azu](https://github.com/azu)
- [twitter/azu_re](https://twitter.com/azu_re)
## License
MIT © azu
This project is based on [eslint-plugin-lodash-template](https://github.com/ota-meshi/eslint-plugin-lodash-template).
```
MIT License
Copyright (c) 2018 Yosuke Ota
```