karma-requirejs-esm-preprocessor 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Ferdinand Prantl
+
+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,63 @@
+# karma-requirejs-esm-preprocessor
+
+[![Latest version](https://img.shields.io/npm/v/karma-requirejs-esm-preprocessor)
+ ![Dependency status](https://img.shields.io/librariesio/release/npm/karma-requirejs-esm-preprocessor)
+](https://www.npmjs.com/package/karma-requirejs-esm-preprocessor)
+
+[Karma] preprocessor for converting ES modules to AMD in [RequireJS] projects. Uses [requirejs-esm-preprocessor].
+
+## Synopsis
+
+```js
+module.exports = config => config.set({
+  preprocessors: {
+    'src/**/*.js': ['requirejs-esm']
+  },
+  requirejsEsmPreprocessor: {
+    isScript: path => !path.includes('/test/'),
+    sourceMap: true
+  }
+})
+```
+
+## Installation
+
+This module can be installed in your project using [NPM], [PNPM] or [Yarn]. Make sure, that you use [Node.js] version 14 or newer.
+
+```sh
+npm i -D karma-requirejs-esm-preprocessor
+pnpm i -D karma-requirejs-esm-preprocessor
+yarn add karma-requirejs-esm-preprocessor
+```
+
+## Configuration
+
+```ts
+isScript(path: string): boolean
+```
+
+Allows further filtering the files before passing them to the preprocessor. If the patterns are inconvenient to specify what files should be preprocessed, a simple pattern can be used to capture all files and the final filtering be done by `isScript` returning `true` only for the paths to files which need preprocessing. The default is `undefined` - no extra filtering.
+
+```ts
+sourceMap: boolean
+```
+
+Enables an inline source map in the preprocessed output to support debugging in the browser. The default is `true`.
+
+## Contributing
+
+In lieu of a formal styleguide, take care to maintain the existing coding style. Lint and test your code.
+
+## License
+
+Copyright (c) 2022 Ferdinand Prantl
+
+Licensed under the MIT license.
+
+[RequireJS]: http://requirejs.org/
+[Karma]: http://karma-runner.github.io/
+[requirejs-esm-preprocessor]: https://www.npmjs.com/package/requirejs-esm-preprocessor#readme
+[Node.js]: http://nodejs.org/
+[NPM]: https://www.npmjs.com/
+[PNPM]: https://pnpm.io/
+[Yarn]: https://yarnpkg.com/

package/index.js

@@ -0,0 +1,21 @@
+const { preprocess } = require('requirejs-esm-preprocessor')
+
+function createPreprocessor(args, config, helper) {
+  const { logLevel, LOG_DEBUG, LOG_DISABLE, requirejsEsmPreprocessor } = config
+  const defaults = { sourceMap: true }
+  const { isScript, sourceMap } = helper.merge(defaults, args, requirejsEsmPreprocessor || {})
+  const verbose = logLevel === LOG_DEBUG
+  const silent = logLevel === LOG_DISABLE
+
+  return (contents, file, done) => {
+    const { originalPath: path } = file
+    if (!isScript || isScript(path)) {
+      contents = preprocess({ path, contents, isScript, sourceMap, verbose, silent })
+    }
+    done(null, contents)
+  }
+}
+
+createPreprocessor.$inject = ['args', 'config', 'helper']
+
+module.exports = { 'preprocessor:requirejs-esm': ['factory', createPreprocessor] }

package/package.json

@@ -0,0 +1,79 @@
+{
+  "name": "karma-requirejs-esm-preprocessor",
+  "version": "1.0.0",
+  "description": "Karma preprocessor for converting ES modules to AMD in RequireJS projects.",
+  "author": "Ferdinand Prantl <prantlf@gmail.com>",
+  "license": "MIT",
+  "licenses": [
+    {
+      "type": "MIT",
+      "url": "https://github.com/prantlf/karma-requirejs-esm-preprocessor/blob/master/LICENSE"
+    }
+  ],
+  "homepage": "https://github.com/prantlf/karma-requirejs-esm-preprocessor#readme",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/prantlf/karma-requirejs-esm-preprocessor.git"
+  },
+  "bugs": {
+    "url": "https://github.com/prantlf/karma-requirejs-esm-preprocessor/issues"
+  },
+  "engines": {
+    "node": ">=14"
+  },
+  "files": [
+    "index.js"
+  ],
+  "scripts": {
+    "lint": "eslint *.js",
+    "fix": "eslint *.js src test",
+    "check1": "karma start test/karma.conf1.js",
+    "check2": "karma start test/karma.conf2.js",
+    "check": "npm run check1 && npm run check2",
+    "cover": "c8 npm run check1 && c8 --no-clean npm run check2 && c8 report -r text -r lcov && c8 check-coverage --100",
+    "test": "npm run lint && npm run cover"
+  },
+  "c8": {
+    "reporter": []
+  },
+  "release": {
+    "plugins": [
+      "@semantic-release/commit-analyzer",
+      "@semantic-release/release-notes-generator",
+      "@semantic-release/changelog",
+      "@semantic-release/npm",
+      [
+        "@semantic-release/github",
+        {
+          "failComment": false
+        }
+      ],
+      "@semantic-release/git"
+    ]
+  },
+  "dependencies": {
+    "requirejs-esm-preprocessor": "^1.0.0"
+  },
+  "devDependencies": {
+    "@semantic-release/changelog": "^6.0.1",
+    "@semantic-release/git": "^10.0.1",
+    "c8": "^7.11.0",
+    "eslint": "^8.12.0",
+    "jasmine-core": "^4.0.1",
+    "karma": "^6.3.17",
+    "karma-brief-reporter": "^0.2.1",
+    "karma-chrome-launcher": "^3.1.1",
+    "karma-jasmine": "^4.0.2"
+  },
+  "keywords": [
+    "karma-preprocessor",
+    "karma-plugin",
+    "karma",
+    "preprocessor",
+    "plugin",
+    "requirejs",
+    "amd",
+    "esm",
+    "es6"
+  ]
+}