refactor(index): add some descriptions, replace is now optional but default as true

Author: Diabeu

src/index.js

@@ -26,23 +26,31 @@ function insertText(str, dir, preprocessor = res => res, processFilename = false
 }
 
 export default function angular(options = {}) {
-  options.preprocessors = options.preprocessors || {};
+  options.preprocessors = options.preprocessors || {}; // set default preprocessors to `{}`
+  options.replace = (typeof options.replace === 'boolean') ? options.replace  : true; // set default replace to `true`
 
   // ignore @angular/** modules
   options.exclude = options.exclude || [];
-  if (typeof options.exclude === 'string' || options.exclude instanceof String) options.exclude = [options.exclude];
-  if (options.exclude.indexOf('node_modules/@angular/**') === -1) options.exclude.push('node_modules/@angular/**');
+  if (typeof options.exclude === 'string' || options.exclude instanceof String) {
+    options.exclude = [options.exclude];
+  }
+  if (options.exclude.indexOf('node_modules/@angular/**') === -1) {
+    options.exclude.push('node_modules/@angular/**');
+  }
 
   const filter = createFilter(options.include, options.exclude);
 
   return {
     name: 'angular',
     transform(source, map) {
       if (!filter(map)) return;
+      // replace comments in source
       source = source.replace(commentRegex, '');
+      // use MagicString
       const magicString = new MagicString(source);
-
+      // get dir from `map`
       const dir = path.parse(map).dir;
+      // get file extension from `map`
       const fileExt = map.split('.').pop();
 
       let hasReplacements = false;
@@ -57,7 +65,7 @@ export default function angular(options = {}) {
           .replace(templateUrlRegex, function (match, url) {
             hasReplacements = true;
             const toReplace = 'template:' + insertText(url, dir, options.preprocessors.template, options.processFilename, options.sourcetype);
-            if (fileExt === 'js') {
+            if (fileExt === 'js' && options.replace === true) {
               /* replace templateUrl in files generated by ngc */
               replace({
                 regex: match,
@@ -74,7 +82,7 @@ export default function angular(options = {}) {
             hasReplacements = true;
             const toReplace = 'styles:' + insertText(urls, dir, options.preprocessors.style, options.processFilename, options.sourcetype);
             /* replace styles in files generated by ngc */
-            if (fileExt === 'js') {
+            if (fileExt === 'js' && options.replace === true) {
               replace({
                 regex: styleUrlsRegex,
                 replacement: toReplace,