auto-ngtemplate-loader

Auto require AngularJS 1.x templates in Webpack style

Usage

Install the package by running npm install auto-ngtemplate-loader. Once installed, you can add it to your Webpack config.

1module.exports = {
2  module: {
3    rules: [
4      {
5        test: /\.js$/,
6        exclude: /node_modules/,
7        use: ['babel-loader', 'other-loaders', 'auto-ngtemplate-loader'],
8      },
9    ],
10  },
11};

Note - It is recommended that this loader be run before any transpilation happens so it can operate on unchanged source code.

The next step is to add ngtemplate-loader and a loader that you want to handle your template code with. The most common one is html-loader. This will run every time Webpack encounters require('something.html').

1module.exports = {
2  module: {
3    rules: [
4      {
5        test: /\.html$/,
6        exclude: /node_modules/,
7        use: [
8          {
9            loader: 'ngtemplate-loader',
10            options: {
11              relativeTo: 'src/',
12            },
13          },
14          {
15            loader: 'html-loader',
16          },
17        ],
18      },
19    ],
20  },
21};

It is a good idea to add the relativeTo option for ngtemplate-loader so that the templates aren't put into the Angular template cache with absolute paths which contain platform specific or user specific information. This will affect the portability of the bundled code.

Options

This module supports configuration through either the options object method or the query string method. The valid options are listed in the table below.

Name	Type	Default Value	Details
variableName	string	autoNgTemplateLoaderTemplate	The variable name that gets injected into the compiled code. This is included so that variable collisions can be prevented.
pathResolver	(path: string) => string	urlToRequest	This function can be used to customize the require path in cases where templates don't use relative paths. This function is called with the path of the template and must return a string which is a valid path.

Webpack v1 Compatible Options

Since Webpack v1 only supports query strings for loaders and doesn't allow passing a function as an option, this loader has a useResolverFromConfig boolean option that can be passed in through the query string. The loader will look for the resolver in the Webpack configuration object under the key autoNgTemplateLoader. The only acceptable member of autoNgTemplateLoader is pathResolver which should be a function that returns a string for all cases. An example is below.

1module.exports = {
2  autoNgTemplateLoader: {
3    pathResolver: (p) => p.replace(/src/, '..').substring(1),
4  },
5  module: {
6    loaders: [
7      {
8        test: /\.js$/,
9        exclude: /node_modules/,
10        loader:
11          'babel-loader!auto-ngtemplate-loader?variableName=testVar&useResolverFromConfig=true',
12      },
13    ],
14  },
15};

Note: The loader will throw an error if useResolverFromConfig is used in Webpack v2 or newer. The recommended way to pass the function is through the options in that case. This is because the Loader API v2 has deprecated a property that is used for the v1 workaround. The loader will check the version and report an error.

Development

Please follow the guidelines in the contribution guide for development.

Installation

Once the repository is cloned, run npm install to get all the dependencies. The examples in this package also depend on ngtemplate-loader and html-loader.

Running

There are a few example projects included. One that has one directive, another that has more, one that uses templates from a different folder, and one that uses absolute paths. You can run npm run one-directive, npm run many-directives, npm run multiple-directives, npm run separated-templates, or npm run absolute-paths to see the loader in action. Once successful, examining the build/bundle.js file under the respective examples folder will show the results.

Testing

The tests for this package are written in with ava. They can be run by running npm test.

Linting

This project uses ESLint. All the requisite files can be linted using npm run linter. The rules for this project are located in eslintrc.json. This will also report prettier errors.

Release procedure

1. Get ready for relaese by updating the main branch by running git pull --rebase. Resolve all the conflicts as necessary.
2. Check package versions if they need updated by running npm outdated and npm update. This will update the package versions that can be updated automatically.
3. If a manual version update is required, make sure to go into package.json and change all the ^ into ~ and regenerate the package-lock.json by running rm -rf node_modules package-lock.json && npm install
4. Determine the next version number by following semantic versioning rules.
5. Add an entry to the CHANGELOG.md file and detail the changes that are shipping with this release.
6. Update the package version in package.json and package-lock.json.
7. Run all the test commands including the example commands.
8. Commit all your changes to main.
9. Create a new pull request from main to stable.
10. Let the automated verification steps run.
11. Merge the code to stable.
12. Checkout stable locally and run npm run publish-dryrun to validate the files that are being shipped. Make sure that it is the most minimal set.
13. Once validated, run npm publish to publish the package.

Miscellaneous

This project also includes an .nvmrc. This is to tell nvm what version of Node.js to use for this project. It is set to v16 which is the current release. However, we run tests on node LTS versions 10, 12, and 14 as well.

Resources

• How to write a Webpack loader
• Webpack Loader API
• How to write a Webpack plugin
• Webpack Plugin API
• Webpack loader-utils

Issue and PR templates derived from smhxx/atom-ts-transpiler.