@oriflame/config-typescript 4.3.0 → 5.0.6

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 ORIFLAME SOFTWARE
+Copyright (c) 2021 ORIFLAME SOFTWARE
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,108 +1,3 @@
-# TypeScript Config
+# @oriflame/config-typescript
 
-Factory functions for creating preset [TypeScript](https://www.typescriptlang.org/) configurations.
-Primarily used in union with the [Lumos](https://www.npmjs.com/package/@oriflame/lumos) CLI.
-
-## Extending config
-
-**Update package.json:**
-
-```json
-{
-  "lumos": {
-    "typescript": {
-      "allowSyntheticDefaultImports": true
-    }
-  }
-}
-```
-
-**Create file in configs folder:**
-
-`configs/typescript.js`
-
-```js
-module.exports = {
-  allowSyntheticDefaultImports: true,
-};
-```
-
-## Settings
-
-### Main settings
-
-```ts
-export interface TypeScriptOptions {
-  buildFolder: string;
-  includeTests?: boolean;
-  library?: boolean;
-  future?: boolean;
-  node?: boolean;
-  react?: boolean;
-  srcFolder: string;
-  testsFolder: string;
-  typesFolder: string;
-  workspaces?: string[];
-  emitDeclarationOnly?: boolean;
-  allowJs?: boolean;
-  skipLibCheck?: boolean;
-}
-```
-
-### Default values
-
-```ts
-{
-  library = false,
-  future = false,
-  node = false,
-  react = false,
-  emitDeclarationOnly = false,
-  srcFolder = 'src',
-  allowJs = false,
-  skipLibCheck = false,
-}
-```
-
-### Settings
-
-- library
-  - Optimized build for library
-- future
-  - Sets target to next version
-- node
-  - Optimized build for node
-- emitDeclarationOnly
-  - Only emits d.ts files
-- srcFolder
-  - Path to source folder
-- allowJs
-  - Enables javascript in typescript
-- skipLibCheck
-  - Skips library check
-
-### CLI Options
-
-- `--[no-]clean`
-  - clean the target `outDir` before transpiling. Defaults to `true`.
-- `--reference-workspaces` / `--reference-workspaces=<string>`
-  - automatically generate project references based on workspace dependency graph. Defaults to
-    `false`.
-- `--emitDeclarationOnly`
-  - emit d.ts files only
-- `--noEmit`
-  - include tests
-- `--buildFolder=<string>`
-  - sets build folder
-- `--srcFolder=<string>`
-  - sets src folder
-- `--testsFolder=<string>`
-  - sets tests folder
-- `--typesFolder=<string>`
-  - sets types folder
-
-**Example:**
-
-```bash
-lumos typescript --emitDeclarationOnly --typesFolder=types
-```
+Documentation was moved to [Lumos package](https://github.com/Oriflame/lumos/tree/master/packages/lumos)

package/dts/index.d.ts

@@ -0,0 +1,15 @@
+import type { TypeScriptConfig } from '@beemo/driver-typescript';
+export interface TypeScriptOptions {
+    sourceMaps?: boolean;
+    library?: boolean;
+    future?: boolean;
+    react?: boolean;
+    srcFolder: string;
+    workspaces?: boolean;
+    allowJs?: boolean;
+    skipLibCheck?: boolean;
+    buildFolder?: string;
+}
+export declare function getCompilerOptions({ library, future, react, srcFolder, allowJs, skipLibCheck, sourceMaps, workspaces, }: Partial<TypeScriptOptions>): import("@beemo/driver-typescript").CompilerOptions;
+export declare function getConfig(options: TypeScriptOptions): TypeScriptConfig;
+//# sourceMappingURL=index.d.ts.map

package/lib/index.js

@@ -1,69 +1,62 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getConfigWithProjectRefs = exports.getConfig = exports.getCompilerOptions = void 0;
-const lumos_common_1 = require("@oriflame/lumos-common");
-function getCompilerOptions({ library = false, future = false, node = false, react = false, emitDeclarationOnly = false, srcFolder = 'src', allowJs = false, skipLibCheck = false, }) {
-    const options = {
-        allowSyntheticDefaultImports: true,
-        declaration: library || emitDeclarationOnly,
-        esModuleInterop: true,
-        forceConsistentCasingInFileNames: true,
-        isolatedModules: !future && !library,
-        jsx: 'preserve',
-        lib: ['dom', 'DOM.Iterable', 'esnext'],
-        module: node ? 'commonjs' : 'esnext',
-        moduleResolution: 'node',
-        noEmitOnError: true,
-        noImplicitReturns: true,
-        pretty: true,
-        strict: true,
-        target: future || node ? 'es2018' : 'es2015',
-        // We want to resolve json modules
-        resolveJsonModule: true,
-        experimentalDecorators: true,
-        // Use define in development for spec accuracy,
-        // but omit in production for smaller file sizes.
-        useDefineForClassFields: future && process.env.NODE_ENV === 'development',
-        allowJs,
-        skipLibCheck,
+'use strict';
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+});
+
+const lumosCommon = require('@oriflame/lumos-common');
+
+const config = require('tsconfig-oriflame/tsconfig.json');
+
+const compilerOptions = config.compilerOptions;
+
+function getCompilerOptions({
+  library = false,
+  future = false,
+  react = false,
+  srcFolder = 'src',
+  allowJs = false,
+  skipLibCheck = false,
+  sourceMaps = true,
+  workspaces
+}) {
+  if (workspaces) {
+    Object.assign(compilerOptions, require('tsconfig-oriflame/tsconfig.workspaces.json').compilerOptions);
+  } // Do we need isolated modules?
+
+
+  compilerOptions.isolatedModules = future && library;
+  compilerOptions.useDefineForClassFields = future && process.env.NODE_ENV === 'development';
+  compilerOptions.allowJs = allowJs;
+  compilerOptions.skipLibCheck = skipLibCheck;
+
+  if (react) {
+    var _compilerOptions$lib;
+
+    compilerOptions.lib = [...((_compilerOptions$lib = compilerOptions.lib) !== null && _compilerOptions$lib !== void 0 ? _compilerOptions$lib : []), 'dom.iterable'];
+    compilerOptions.jsx = 'react-jsx';
+  }
+
+  if (!library) {
+    compilerOptions.baseUrl = '.';
+    compilerOptions.paths = {
+      [`${lumosCommon.ALIAS_PATTERN}/*`]: [`./${srcFolder}/*`]
     };
-    if (react) {
-        // @ts-expect-error -- not typed
-        options.jsx = 'react-jsx';
-    }
-    if (!library) {
-        options.baseUrl = '.';
-        options.paths = {
-            [`${lumos_common_1.ALIAS_PATTERN}/*`]: [`./${srcFolder}/*`],
-        };
-    }
-    return options;
+  }
+
+  if (sourceMaps) {
+    compilerOptions.sourceMap = true;
+  }
+
+  return compilerOptions;
 }
-exports.getCompilerOptions = getCompilerOptions;
+
 function getConfig(options) {
-    const config = {
-        compilerOptions: getCompilerOptions(options),
-        include: [`./${options.srcFolder}/**/*`, `./${options.typesFolder}/**/*`],
-        exclude: ['**/node_modules/*'],
-    };
-    if (options.includeTests) {
-        config.include.push(`./${options.testsFolder}/**/*`);
-    }
-    if (options.library) {
-        config.compilerOptions.declarationDir = `./${options.buildFolder}`;
-    }
-    config.compilerOptions.outDir = `./${options.buildFolder}`;
-    return config;
+  return {
+    compilerOptions: getCompilerOptions(options)
+  };
 }
+
+exports.getCompilerOptions = getCompilerOptions;
 exports.getConfig = getConfig;
-function getConfigWithProjectRefs(options) {
-    const config = {
-        compilerOptions: getCompilerOptions(options),
-        files: [],
-        references: [],
-    };
-    config.compilerOptions.composite = true;
-    config.compilerOptions.declarationMap = true;
-    return config;
-}
-exports.getConfigWithProjectRefs = getConfigWithProjectRefs;
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../src/index.ts"],"sourcesContent":null,"names":["config","require","compilerOptions","getCompilerOptions","library","future","react","srcFolder","allowJs","skipLibCheck","sourceMaps","workspaces","Object","assign","isolatedModules","useDefineForClassFields","process","env","NODE_ENV","lib","jsx","baseUrl","paths","ALIAS_PATTERN","sourceMap","getConfig","options"],"mappings":";;;;;;AAGA,MAAMA,MAAM,GAAGC,OAAO,CAAC,iCAAD,CAAtB;;AAEA,MAAMC,eAAe,GAAGF,MAAM,CAACE,eAA/B;AAcO,SAASC,kBAAT,CAA4B;AACjCC,EAAAA,OAAO,GAAG,KADuB;AAEjCC,EAAAA,MAAM,GAAG,KAFwB;AAGjCC,EAAAA,KAAK,GAAG,KAHyB;AAIjCC,EAAAA,SAAS,GAAG,KAJqB;AAKjCC,EAAAA,OAAO,GAAG,KALuB;AAMjCC,EAAAA,YAAY,GAAG,KANkB;AAOjCC,EAAAA,UAAU,GAAG,IAPoB;AAQjCC,EAAAA;AARiC,CAA5B,EASwB;AAC7B,MAAIA,UAAJ,EAAgB;AACdC,IAAAA,MAAM,CAACC,MAAP,CACEX,eADF,EAEGD,OAAO,CAAC,4CAAD,CAAR,CAA4EC,eAF9E;AAID,GAN4B;;;AAQ7BA,EAAAA,eAAe,CAACY,eAAhB,GAAkCT,MAAM,IAAID,OAA5C;AACAF,EAAAA,eAAe,CAACa,uBAAhB,GAA0CV,MAAM,IAAIW,OAAO,CAACC,GAAR,CAAYC,QAAZ,KAAyB,aAA7E;AACAhB,EAAAA,eAAe,CAACM,OAAhB,GAA0BA,OAA1B;AACAN,EAAAA,eAAe,CAACO,YAAhB,GAA+BA,YAA/B;;AAEA,MAAIH,KAAJ,EAAW;AACTJ,IAAAA,eAAe,CAACiB,GAAhB,GAAsB,CAAC,IAAIjB,eAAe,CAACiB,GAAhB,IAAuB,EAA3B,CAAD,EAAiC,cAAjC,CAAtB;AACAjB,IAAAA,eAAe,CAACkB,GAAhB,GAAsB,WAAtB;AACD;;AAED,MAAI,CAAChB,OAAL,EAAc;AACZF,IAAAA,eAAe,CAACmB,OAAhB,GAA0B,GAA1B;AACAnB,IAAAA,eAAe,CAACoB,KAAhB,GAAwB;AACtB,OAAE,GAAEC,yBAAc,IAAlB,GAAwB,CAAE,KAAIhB,SAAU,IAAhB;AADF,KAAxB;AAGD;;AAED,MAAIG,UAAJ,EAAgB;AACdR,IAAAA,eAAe,CAACsB,SAAhB,GAA4B,IAA5B;AACD;;AAED,SAAOtB,eAAP;AACD;AAEM,SAASuB,SAAT,CAAmBC,OAAnB,EAAiE;AACtE,SAAO;AACLxB,IAAAA,eAAe,EAAEC,kBAAkB,CAACuB,OAAD;AAD9B,GAAP;AAGD;;;;;"}

package/package.json

@@ -1,13 +1,14 @@
 {
   "name": "@oriflame/config-typescript",
-  "version": "4.3.0",
-  "description": "Reusable TypeScript configs.",
+  "version": "5.0.6",
+  "description": "Reusable typescript config.",
   "keywords": [
     "lumos",
     "config",
     "typescript"
   ],
-  "main": "lib/index.js",
+  "main": "./lib/index.js",
+  "types": "./dts/index.d.ts",
   "repository": {
     "type": "git",
     "url": "git@github.com:Oriflame/lumos.git"
@@ -18,13 +19,31 @@
     "access": "public"
   },
   "engines": {
-    "node": ">=10.16.0"
+    "node": ">=12.17.0",
+    "npm": ">=6.13.0"
   },
+  "files": [
+    "dts/**/*.d.ts",
+    "lib/**/*.{js,map}",
+    "src/**/*.{ts,tsx,json}"
+  ],
   "dependencies": {
-    "@beemo/core": "^1.1.8",
-    "@beemo/driver-typescript": "^1.4.1",
-    "@oriflame/lumos-common": "^4.3.0",
-    "typescript": "^4.4.3"
+    "@oriflame/lumos-common": "^5.0.6",
+    "tsconfig-oriflame": "^5.0.6"
+  },
+  "devDependencies": {
+    "@beemo/core": "^2.1.3",
+    "@beemo/driver-typescript": "^2.1.1",
+    "typescript": "^4.5.4"
+  },
+  "peerDependencies": {
+    "@beemo/core": "^2.1.2",
+    "@beemo/driver-typescript": "^2.1.0",
+    "typescript": "^4.5.4"
+  },
+  "packemon": {
+    "format": "lib",
+    "platform": "node"
   },
-  "gitHead": "82c127cb45ef16c0937f17e5f9bb03d53fba155a"
+  "gitHead": "72ec8d41e2e5e538729c9384a13ce6d00b18dccb"
 }

package/src/index.ts

@@ -1,102 +1,65 @@
-import { TypeScriptConfig } from '@beemo/driver-typescript';
+import type { TypeScriptConfig } from '@beemo/driver-typescript';
 import { ALIAS_PATTERN } from '@oriflame/lumos-common';
 
-// Keep in sync with the `tsconfig.options.json` file in this package.
+const config = require('tsconfig-oriflame/tsconfig.json') as TypeScriptConfig;
+
+const compilerOptions = config.compilerOptions!;
+
 export interface TypeScriptOptions {
-  buildFolder: string;
-  includeTests?: boolean;
+  sourceMaps?: boolean;
   library?: boolean;
   future?: boolean;
-  node?: boolean;
   react?: boolean;
   srcFolder: string;
-  testsFolder: string;
-  typesFolder: string;
-  workspaces?: string[];
-  emitDeclarationOnly?: boolean;
+  workspaces?: boolean;
   allowJs?: boolean;
   skipLibCheck?: boolean;
+  buildFolder?: string;
 }
 
 export function getCompilerOptions({
   library = false,
   future = false,
-  node = false,
   react = false,
-  emitDeclarationOnly = false,
   srcFolder = 'src',
   allowJs = false,
   skipLibCheck = false,
+  sourceMaps = true,
+  workspaces,
 }: Partial<TypeScriptOptions>) {
-  const options: TypeScriptConfig['compilerOptions'] = {
-    allowSyntheticDefaultImports: true,
-    declaration: library || emitDeclarationOnly,
-    esModuleInterop: true,
-    forceConsistentCasingInFileNames: true,
-    isolatedModules: !future && !library,
-    jsx: 'preserve',
-    lib: ['dom', 'DOM.Iterable', 'esnext'],
-    module: node ? 'commonjs' : 'esnext',
-    moduleResolution: 'node',
-    noEmitOnError: true,
-    noImplicitReturns: true,
-    pretty: true,
-    strict: true,
-    target: future || node ? 'es2018' : 'es2015',
-    // We want to resolve json modules
-    resolveJsonModule: true,
-    experimentalDecorators: true,
-    // Use define in development for spec accuracy,
-    // but omit in production for smaller file sizes.
-    useDefineForClassFields: future && process.env.NODE_ENV === 'development',
-    allowJs,
-    skipLibCheck,
-  };
+  if (workspaces) {
+    Object.assign(
+      compilerOptions,
+      (require('tsconfig-oriflame/tsconfig.workspaces.json') as TypeScriptConfig).compilerOptions,
+    );
+  }
+  // Do we need isolated modules?
+  compilerOptions.isolatedModules = future && library;
+  compilerOptions.useDefineForClassFields = future && process.env.NODE_ENV === 'development';
+  compilerOptions.allowJs = allowJs;
+  compilerOptions.skipLibCheck = skipLibCheck;
 
   if (react) {
-    // @ts-expect-error -- not typed
-    options.jsx = 'react-jsx';
+    compilerOptions.lib = [...(compilerOptions.lib ?? []), 'dom.iterable'];
+    compilerOptions.jsx = 'react-jsx';
   }
 
   if (!library) {
-    options.baseUrl = '.';
-    options.paths = {
+    compilerOptions.baseUrl = '.';
+    compilerOptions.paths = {
       [`${ALIAS_PATTERN}/*`]: [`./${srcFolder}/*`],
     };
   }
 
-  return options;
-}
-
-export function getConfig(options: TypeScriptOptions): TypeScriptConfig {
-  const config = {
-    compilerOptions: getCompilerOptions(options),
-    include: [`./${options.srcFolder}/**/*`, `./${options.typesFolder}/**/*`],
-    exclude: ['**/node_modules/*'],
-  };
-
-  if (options.includeTests) {
-    config.include.push(`./${options.testsFolder}/**/*`);
-  }
-
-  if (options.library) {
-    config.compilerOptions.declarationDir = `./${options.buildFolder}`;
+  if (sourceMaps) {
+    compilerOptions.sourceMap = true;
   }
 
-  config.compilerOptions.outDir = `./${options.buildFolder}`;
-
-  return config;
+  return compilerOptions;
 }
 
-export function getConfigWithProjectRefs(options: Partial<TypeScriptOptions>): TypeScriptConfig {
-  const config = {
+export function getConfig(options: TypeScriptOptions): TypeScriptConfig {
+  return {
     compilerOptions: getCompilerOptions(options),
-    files: [],
-    references: [],
   };
-
-  config.compilerOptions.composite = true;
-  config.compilerOptions.declarationMap = true;
-
-  return config;
 }