chore: add examples on how to use it with import assertions (#60)

.gitignore

@@ -1,2 +1,3 @@
 node_modules
 dist
+**/.DS_Store

examples/karma-ts/karma.conf.js

@@ -1,5 +1,6 @@
 const istanbul = require("rollup-plugin-istanbul")
 const typescript = require("@rollup/plugin-typescript")
+const json = require("@rollup/plugin-json")
 
 module.exports = (config) => {
 	config.set({
@@ -25,11 +26,18 @@ module.exports = (config) => {
 		rollupPreprocessor: {
 			plugins: [
 				typescript(),
+				json(),
 				istanbul({
 					exclude: ["spec/**/*.spec.ts"],
 					sourceMap: true,
 					instrumenterConfig: {
 						produceSourceMap: true,
+						parserPlugins: [
+							["importAttributes", { deprecatedAssertSyntax: true }],
+						],
+						generatorOpts: {
+							importAttributesKeyword: "assert",
+						},
 					},
 				}),
 			],

examples/karma-ts/package.json

@@ -15,6 +15,7 @@
 	},
 	"license": "MIT",
 	"devDependencies": {
+		"@rollup/plugin-json": "^6.1.0",
 		"@rollup/plugin-typescript": "^12.1.0",
 		"@types/chai": "^4.3.20",
 		"@types/mocha": "^10.0.8",

examples/karma-ts/rollup.config.mjs

@@ -1,3 +1,4 @@
+import json from "@rollup/plugin-json"
 import typescript from "@rollup/plugin-typescript"
 
 export default {
@@ -17,5 +18,5 @@ export default {
 			file: "./dist/example.cjs.js",
 		},
 	],
-	plugins: [typescript()],
+	plugins: [typescript(), json()],
 }

examples/karma-ts/src/data.json

@@ -0,0 +1,3 @@
+{
+	"json": true
+}

examples/karma-ts/src/index.ts

@@ -1,5 +1,7 @@
 import { sum } from "./sum"
 
+import data from "./data.json" assert { type: "json" }
+
 interface Example {
 	sum(a: number, b: number): number
 	subtract(a: number, b: number): number
@@ -25,3 +27,7 @@ export const example: Example = {
 		return multiply(a, b)
 	},
 }
+
+export const logData = () => {
+	console.log(data)
+}

examples/karma-ts/tsconfig.json

@@ -27,15 +27,15 @@
 		/* Modules */
 		"module": "esnext" /* Specify what module code is generated. */,
 		// "rootDir": "./",                                  /* Specify the root folder within your source files. */
-		// "moduleResolution": "node",                       /* Specify how TypeScript looks up a file from a given module specifier. */
+		"moduleResolution": "node" /* Specify how TypeScript looks up a file from a given module specifier. */,
 		// "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
 		// "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
 		// "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
 		// "typeRoots": [],                                  /* Specify multiple folders that act like './node_modules/@types'. */
 		// "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */
 		// "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
 		// "moduleSuffixes": [],                             /* List of file name suffixes to search when resolving a module. */
-		// "resolveJsonModule": true,                        /* Enable importing .json files. */
+		"resolveJsonModule": true /* Enable importing .json files. */,
 		// "noResolve": true,                                /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
 
 		/* JavaScript Support */
@@ -52,7 +52,7 @@
 		// "outDir": "./",                                   /* Specify an output folder for all emitted files. */
 		// "removeComments": true,                           /* Disable emitting comments. */
 		// "noEmit": true,                                   /* Disable emitting files from a compilation. */
-		// "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
+		"importHelpers": true /* Allow importing helper functions from tslib once per project, instead of including them per-file. */,
 		// "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types. */
 		// "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
 		// "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */