feat: restructure project with src/ and build/ (#307)

To keep source files in a single place, most js files are now located in
the src folder as well. The TypeScript compiler transpiles the ts files
and copies the js files to the build folder.

Author: wtho

.gitignore

@@ -1,4 +1,5 @@
 node_modules
+/build/
 InlineFilesTransformer.js
 StripStylesTransformer.js
 TransformUtils.js

.npmignore

@@ -1,4 +1,3 @@
 /example
-/__tests__
 /src
 circle.yml

CHANGELOG.md

@@ -2,8 +2,11 @@
 
 * (**BREAKING**): Refine ast-transformer behavior: only transform `styles`-assignments inside @Component ([#261](https://github.com/thymikee/jest-preset-angular/pull/261)) and TypeScript v2.9 `createStringLiteral` is polyfilled if an older version is used ([#272](https://github.com/thymikee/jest-preset-angular/issues/272)).
 
+* (**BREAKING**): Restructure project with `src` and `build` folder ([#307](https://github.com/thymikee/jest-preset-angular/pull/307)). 
+
 #### Migration Guide
-* If the `astTransformers` are referenced in a custom `jest` config, `[ 'jest-preset-angular/InlineFilesTransformer', 'jest-preset-angular/StripStylesTransformer']` have to be set instead.
+* If the `astTransformers` are referenced in a custom `jest` config, `[ 'jest-preset-angular/build/InlineFilesTransformer', 'jest-preset-angular/build/StripStylesTransformer']` have to be set instead.
+* Serializers, transformers and `setupJest` have to be referenced from the `jest-preset-angular/build/`-folder in a custom config. Existing references have to be aligned.
 
 ### v7.1.0
 

README.md

@@ -53,7 +53,10 @@ module.exports = {
     'ts-jest': {
       tsConfig: '<rootDir>/src/tsconfig.spec.json',
       stringifyContentPathRegex: '\\.html$',
-      astTransformers: [require.resolve('./InlineHtmlStripStylesTransformer')],
+      astTransformers: [
+        require.resolve('./build/InlineFilesTransformer'),
+        require.resolve('./build/StripStylesTransformer')
+      ],
     },
   },
   transform: {
@@ -69,8 +72,8 @@ module.exports = {
   },
   transformIgnorePatterns: ['node_modules/(?!@ngrx)'],
   snapshotSerializers: [
-    'jest-preset-angular/AngularSnapshotSerializer.js',
-    'jest-preset-angular/HTMLCommentSerializer.js',
+    'jest-preset-angular/build/AngularSnapshotSerializer.js',
+    'jest-preset-angular/build/HTMLCommentSerializer.js',
   ],
 };
 ```
@@ -305,14 +308,17 @@ Override `globals` object in Jest config:
       "ts-jest": {
         "tsConfig": "<rootDir>/src/tsconfig.custom.json",
         "stringifyContentPathRegex": "\\.html$",
-        "astTransformers": ["jest-preset-angular/InlineHtmlStripStylesTransformer"],
+        "astTransformers": [
+          "jest-preset-angular/build/InlineFilesTransformer",
+          "jest-preset-angular/build/StripStylesTransformer"
+        ],
       }
     }
   }
 }
 ```
 
-If you choose to overide `globals` in order to point at a specific tsconfig, you will need to add `"astTransformers": ["jest-preset-angular/InlineHtmlStripStylesTransformer"]` to the `globals.ts-jest` section too, otherwise you will get parse errors on any html templates.
+If you choose to overide `globals` in order to point at a specific tsconfig, you will need to add the `astTransformers` to the `globals.ts-jest` section too, otherwise you will get parse errors on any html templates.
 
 ### Unexpected token [import|export|other]
 
@@ -411,7 +417,7 @@ module.exports = function(api) {
 {
   "jest": {
     "transform": {
-      "^.+\\.(ts|html)$": "<rootDir>/node_modules/jest-preset-angular/preprocessor.js",
+      "^.+\\.(ts|html)$": "ts-jest",
       "^.+\\.js$": "babel-jest"
     },
   }

example/package.json

@@ -45,9 +45,9 @@
   "jest": {
     "preset": "jest-preset-angular",
     "snapshotSerializers": [
-      "jest-preset-angular/AngularNoNgAttributesSnapshotSerializer.js",
-      "jest-preset-angular/AngularSnapshotSerializer.js",
-      "jest-preset-angular/HTMLCommentSerializer.js"
+      "jest-preset-angular/build/AngularNoNgAttributesSnapshotSerializer.js",
+      "jest-preset-angular/build/AngularSnapshotSerializer.js",
+      "jest-preset-angular/build/HTMLCommentSerializer.js"
     ],
     "moduleNameMapper": {
       "\\.(jpg|jpeg|png)$": "<rootDir>/__mocks__/image.js",

index.js

@@ -1 +1 @@
-module.exports = require('./setupJest.js');	
+module.exports = require('./build/setupJest.js');	

jest-preset.js

@@ -4,8 +4,8 @@ module.exports = {
       tsConfig: '<rootDir>/src/tsconfig.spec.json',
       stringifyContentPathRegex: '\\.html$',
       astTransformers: [
-        require.resolve('./InlineFilesTransformer'),
-        require.resolve('./StripStylesTransformer'),
+        require.resolve('./build/InlineFilesTransformer'),
+        require.resolve('./build/StripStylesTransformer'),
       ],
     },
   },
@@ -22,8 +22,8 @@ module.exports = {
   },
   transformIgnorePatterns: ['node_modules/(?!@ngrx)'],
   snapshotSerializers: [
-    // 'jest-preset-angular/AngularNoNgAttributesSnapshotSerializer.js',
-    'jest-preset-angular/AngularSnapshotSerializer.js',
-    'jest-preset-angular/HTMLCommentSerializer.js',
+    // 'jest-preset-angular/build/AngularNoNgAttributesSnapshotSerializer.js',
+    'jest-preset-angular/build/AngularSnapshotSerializer.js',
+    'jest-preset-angular/build/HTMLCommentSerializer.js',
   ],
 };

package.json

@@ -31,7 +31,7 @@
         "tsConfig": "<rootDir>/tsconfig.spec.json"
       }
     },
-    "rootDir": "__tests__"
+    "rootDir": "src/__tests__"
   },
   "scripts": {
     "build": "tsc",