@jscutlery/swc-angular 0.12.0

package/CHANGELOG.md

@@ -0,0 +1,91 @@
+## 0.12.0 (2024-04-12)
+
+
+### 🚀 Features
+
+- **swc-angular:** ✨ rename swc-angular packages ([#324](https://github.com/jscutlery/devkit/pull/324))
+
+
+### ❤️  Thank You
+
+- Younes Jaaidi
+
+## 0.3.0 (2024-04-11)
+
+
+### 🚀 Features
+
+- **swc-angular-preset:** ✨ fail gracefully if @swc/core is incompatible ([#322](https://github.com/jscutlery/devkit/pull/322))
+
+
+### ❤️  Thank You
+
+- Younes Jaaidi
+
+## 0.2.2 (2024-04-09)
+
+
+### 🩹 Fixes
+
+- **swc-angular-preset:** 🐞 fix jest preset typing ([9c6de1c](https://github.com/jscutlery/devkit/commit/9c6de1c))
+
+
+### ❤️  Thank You
+
+- Younes Jaaidi
+
+## 0.2.1 (2024-04-08)
+
+
+### 🩹 Fixes
+
+- **swc-plugin-angular:** 🐞 transform async/await ([#313](https://github.com/jscutlery/devkit/pull/313))
+
+
+### ❤️  Thank You
+
+- Younes Jaaidi
+
+## 0.2.0 (2024-04-04)
+
+
+### 🚀 Features
+
+- **swc-angular-preset:** ✨ add vite support ([#307](https://github.com/jscutlery/devkit/pull/307))
+
+
+### ❤️  Thank You
+
+- Younes Jaaidi
+
+## 0.1.2 (2024-04-02)
+
+### 🩹 Fixes
+
+- **swc-angular-preset:** 🐞 publish dist artefact
+
+
+## 0.1.1 (2024-03-29)
+
+
+### 🩹 Fixes
+
+- **swc-angular-preset:** 🐞 allow recent versions of swc-plugin-angular ([c715414](https://github.com/jscutlery/devkit/commit/c715414))
+
+
+### ❤️  Thank You
+
+- Edouard Bozon @edbzn
+- Younes Jaaidi
+
+## 0.1.0 (2024-03-26)
+
+
+### 🚀 Features
+
+- ✨ add swc-angular-preset and swc-plugin-angular ([#273](https://github.com/jscutlery/devkit/pull/273))
+
+
+### ❤️  Thank You
+
+- Edouard Bozon @edbzn

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 jscutlery
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,110 @@
+# ⚡️ Speed Up Angular Testing with SWC 🦀
+
+## 👀 What is this?
+
+This is a set of Angular presets that enable you to use [SWC (Speedy Web Compiler)](https://swc.rs/) with Jest or
+Vitest.
+
+**Switching to SWC can speed up your tests by 2x to 5x.**
+
+## 🤔 Context
+
+Surprisingly, in most cases, the bottleneck in Jest & Vitest tests is not the test execution time nor the Angular JIT
+(Just-In-Time) compiler but the TypeScript transformer.
+
+This is where SWC (Speedy Web Compiler) comes in. SWC is a JavaScript/TypeScript compiler that aims to be extremely
+fast.
+
+This package enables you to use SWC with Angular projects by setting the right configuration for SWC and using
+our Angular plugin for SWC [`@jscutlery/swc-angular-plugin`](../swc-angular-plugin)
+
+## 🥇 Benchmark
+
+| ts-jest | @swc/jest           |
+|---------|---------------------|
+| 85s     | 35s _(2.4x faster)_ |
+
+💻 try it yourself: https://github.com/yjaaidi/experiments/tree/angular-jest-swc-benchmark
+
+## 🎭 Setup with Jest
+
+### 1. Install
+
+Install this preset and its dependencies via npm:
+
+```sh
+npm install -D @jscutlery/swc-angular @jscutlery/swc-angular-plugin @swc/core @swc/jest
+grep .swc .gitignore || echo .swc >> .gitignore
+```
+
+### 2. Configure
+
+In your Jest configuration file (e.g., `jest.config.ts`), use the `swcAngularJestTransformer` function to
+transform `.ts`, `.js`, and `.mjs` files.
+
+```js
+import { swcAngularJestTransformer } from '@jscutlery/swc-angular';
+
+export default {
+  // ...
+  transform: {
+    '^.+\\.(ts|mjs|js)$': swcAngularJestTransformer(),
+    '^.+\\.(html)$':
+      [
+        'jest-preset-angular',
+        {
+          tsconfig: '<rootDir>/tsconfig.spec.json',
+          stringifyContentPathRegex: '\\.(html|svg)$',
+        },
+      ],
+  },
+  transformIgnorePatterns: ['node_modules/(?!.*\\.mjs$)'],
+  // ...
+};
+```
+
+### 3. Add `reflect-metadata`
+
+In order for constructor injection to work, you need to import `reflect-metadata` in the setup file which is probably
+located at `src/test-setup.ts`.
+
+```ts
+import 'reflect-metadata';
+```
+
+## ⚡️Setup with Vitest
+
+### 1. Install
+
+Install this preset and its dependencies via npm:
+
+```sh
+npm install -D @jscutlery/swc-angular @jscutlery/swc-angular-plugin @swc/core unplugin-swc
+grep .swc .gitignore || echo .swc >> .gitignore
+```
+
+### 2. Configure
+
+In your vite configuration file (e.g., `vite.config.ts`), use the `unplugin-swc` plugin with our
+preset: `swcAngularVitePreset`.
+
+```js
+import { swcAngularUnpluginOptions } from '@jscutlery/swc-angular';
+import swc from 'unplugin-swc';
+import { defineConfig } from 'vite';
+
+export default defineConfig({
+  // ...
+  plugins: [swc.vite(swcAngularUnpluginOptions())]
+  // ...
+});
+```
+
+### 3. Add `reflect-metadata`
+
+In order for constructor injection to work, you need to import `reflect-metadata` in the setup file which is probably
+located at `src/test-setup.ts`.
+
+```ts
+import 'reflect-metadata';
+```

package/index.cjs.d.ts

@@ -0,0 +1,2 @@
+export * from "./src/index";
+export { default } from "./src/index";

package/index.cjs.js

@@ -0,0 +1,90 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var core = require('@swc/core');
+
+function _extends() {
+    _extends = Object.assign || function assign(target) {
+        for(var i = 1; i < arguments.length; i++){
+            var source = arguments[i];
+            for(var key in source)if (Object.prototype.hasOwnProperty.call(source, key)) target[key] = source[key];
+        }
+        return target;
+    };
+    return _extends.apply(this, arguments);
+}
+
+assertCompatibleSwcCoreVersion();
+function swcAngularPreset(options = {}) {
+    return {
+        jsc: {
+            parser: {
+                syntax: 'typescript',
+                decorators: true,
+                dynamicImport: true
+            },
+            transform: {
+                legacyDecorator: true,
+                decoratorMetadata: true
+            },
+            experimental: {
+                plugins: [
+                    [
+                        '@jscutlery/swc-angular-plugin',
+                        {
+                            templateRawSuffix: options.templateRawSuffix
+                        }
+                    ]
+                ]
+            }
+        },
+        env: {
+            include: [
+                'transform-async-to-generator'
+            ]
+        }
+    };
+}
+function swcAngularJestTransformer() {
+    return [
+        '@swc/jest',
+        swcAngularPreset()
+    ];
+}
+function swcAngularVitePreset() {
+    return swcAngularPreset({
+        templateRawSuffix: true
+    });
+}
+function swcAngularUnpluginOptions() {
+    return _extends({}, swcAngularVitePreset(), {
+        /* Since we are using SWC's env option, we need to disable the tsconfigFile option.
+     * Otherwise `unpluggin-swc` will try to use the target from the tsconfig's `compilerOptions`,
+     * and make SWC produce the following error: "`env` and `jsc.target` cannot be used together".
+     *
+     * We could have added this extra option to `swcAngularVitePreset`, but forwarding any extra option
+     * to SWC will make SWC's configuration parser fail.
+     *
+     * Cf.  https://github.com/unplugin/unplugin-swc/issues/137 */ tsconfigFile: false
+    });
+}
+/**
+ * @deprecated Use {@link swcAngularVitePreset}, {@link swcAngularJestTransformer} or {@link swcAngularPreset} instead.
+ */ var index = swcAngularPreset();
+function assertCompatibleSwcCoreVersion() {
+    if (!core.version.startsWith('1.4.')) {
+        console.warn(`
+    @swc/core version ${core.version} is incompatible with @jscutlery/swc-angular.
+    Please use @swc/core version 1.4.x.
+    > npm add -D @swc/core@~1.4.0
+    `);
+        process.exit(1);
+    }
+}
+
+exports["default"] = index;
+exports.swcAngularJestTransformer = swcAngularJestTransformer;
+exports.swcAngularPreset = swcAngularPreset;
+exports.swcAngularUnpluginOptions = swcAngularUnpluginOptions;
+exports.swcAngularVitePreset = swcAngularVitePreset;

package/index.esm.d.ts

@@ -0,0 +1,2 @@
+export * from "./src/index";
+export { default } from "./src/index";

package/index.esm.js

@@ -0,0 +1,82 @@
+import { version } from '@swc/core';
+
+function _extends() {
+    _extends = Object.assign || function assign(target) {
+        for(var i = 1; i < arguments.length; i++){
+            var source = arguments[i];
+            for(var key in source)if (Object.prototype.hasOwnProperty.call(source, key)) target[key] = source[key];
+        }
+        return target;
+    };
+    return _extends.apply(this, arguments);
+}
+
+assertCompatibleSwcCoreVersion();
+function swcAngularPreset(options = {}) {
+    return {
+        jsc: {
+            parser: {
+                syntax: 'typescript',
+                decorators: true,
+                dynamicImport: true
+            },
+            transform: {
+                legacyDecorator: true,
+                decoratorMetadata: true
+            },
+            experimental: {
+                plugins: [
+                    [
+                        '@jscutlery/swc-angular-plugin',
+                        {
+                            templateRawSuffix: options.templateRawSuffix
+                        }
+                    ]
+                ]
+            }
+        },
+        env: {
+            include: [
+                'transform-async-to-generator'
+            ]
+        }
+    };
+}
+function swcAngularJestTransformer() {
+    return [
+        '@swc/jest',
+        swcAngularPreset()
+    ];
+}
+function swcAngularVitePreset() {
+    return swcAngularPreset({
+        templateRawSuffix: true
+    });
+}
+function swcAngularUnpluginOptions() {
+    return _extends({}, swcAngularVitePreset(), {
+        /* Since we are using SWC's env option, we need to disable the tsconfigFile option.
+     * Otherwise `unpluggin-swc` will try to use the target from the tsconfig's `compilerOptions`,
+     * and make SWC produce the following error: "`env` and `jsc.target` cannot be used together".
+     *
+     * We could have added this extra option to `swcAngularVitePreset`, but forwarding any extra option
+     * to SWC will make SWC's configuration parser fail.
+     *
+     * Cf.  https://github.com/unplugin/unplugin-swc/issues/137 */ tsconfigFile: false
+    });
+}
+/**
+ * @deprecated Use {@link swcAngularVitePreset}, {@link swcAngularJestTransformer} or {@link swcAngularPreset} instead.
+ */ var index = swcAngularPreset();
+function assertCompatibleSwcCoreVersion() {
+    if (!version.startsWith('1.4.')) {
+        console.warn(`
+    @swc/core version ${version} is incompatible with @jscutlery/swc-angular.
+    Please use @swc/core version 1.4.x.
+    > npm add -D @swc/core@~1.4.0
+    `);
+        process.exit(1);
+    }
+}
+
+export { index as default, swcAngularJestTransformer, swcAngularPreset, swcAngularUnpluginOptions, swcAngularVitePreset };

package/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "@jscutlery/swc-angular",
+  "version": "0.12.0",
+  "repository": {
+    "url": "https://github.com/jscutlery/devkit"
+  },
+  "keywords": [
+    "SWC",
+    "Angular",
+    "Plugin",
+    "Testing"
+  ],
+  "peerDependencies": {
+    "@jscutlery/swc-angular-plugin": ">=0.11.0 <1.0.0",
+    "@swc/core": "~1.4.0"
+  },
+  "module": "./index.esm.js",
+  "main": "./index.cjs.js"
+}

package/src/index.d.ts

@@ -0,0 +1,72 @@
+import type { Config } from '@swc/core';
+export interface AngularPresetOptions {
+    templateRawSuffix?: boolean;
+}
+export declare function swcAngularPreset(options?: AngularPresetOptions): {
+    jsc: {
+        parser: {
+            syntax: "typescript";
+            decorators: true;
+            dynamicImport: true;
+        };
+        transform: {
+            legacyDecorator: true;
+            decoratorMetadata: true;
+        };
+        experimental: {
+            plugins: [string, SwcPluginAngularOptions][];
+        };
+    };
+    env: {
+        include: string[];
+    };
+};
+export declare function swcAngularJestTransformer(): [string, Record<string, unknown>];
+export declare function swcAngularVitePreset(): {
+    jsc: {
+        parser: {
+            syntax: "typescript";
+            decorators: true;
+            dynamicImport: true;
+        };
+        transform: {
+            legacyDecorator: true;
+            decoratorMetadata: true;
+        };
+        experimental: {
+            plugins: [string, SwcPluginAngularOptions][];
+        };
+    };
+    env: {
+        include: string[];
+    };
+};
+export declare function swcAngularUnpluginOptions(): Config & {
+    tsconfigFile?: boolean;
+};
+interface SwcPluginAngularOptions {
+    templateRawSuffix?: boolean;
+}
+/**
+ * @deprecated Use {@link swcAngularVitePreset}, {@link swcAngularJestTransformer} or {@link swcAngularPreset} instead.
+ */
+declare const _default: {
+    jsc: {
+        parser: {
+            syntax: "typescript";
+            decorators: true;
+            dynamicImport: true;
+        };
+        transform: {
+            legacyDecorator: true;
+            decoratorMetadata: true;
+        };
+        experimental: {
+            plugins: [string, SwcPluginAngularOptions][];
+        };
+    };
+    env: {
+        include: string[];
+    };
+};
+export default _default;

package/src/index.spec-d.d.ts

@@ -0,0 +1 @@
+export {};