use-on-demand
Version:
317 lines • 15.8 kB
JavaScript
import { __assign, __read, __spread } from "tslib";
import { TypeScript_SpeedUp_Helper } from './gen-helper';
/**
* 使用本文件，动态生成【tsconfig.json】。
*/
/**
* 【nuxt.js】库，相关的【特殊化处理】。
*/
var NuxtJs_TsConfig_Helper = /** @class */ (function () {
function NuxtJs_TsConfig_Helper() {
}
NuxtJs_TsConfig_Helper._include = [
// WARN 适配【nuxt.js】，这段include去除 （TIP 后来又发现，不用去除）
//
// "src/**/*.ts",
// "src/**/*.tsx",
// "src/**/*.vue",
// "tests/**/*.ts",
// "tests/**/*.tsx"
//
'sources/ts/ts-types/**/*.d.ts',
'sources/ts/ts-types/**/*.ts',
//
'sources/**/*.d.ts',
'sources/**/*.ts',
'sources/**/*.tsx',
'sources/**/*.vue',
//
/*
'**!/!*.ts',
'**!/!*.d.ts',
'**!/!*.tsx',
'**!/!*.vue',
*/
//
// "config/**/*.ts",
// "config/**/*.tsx",
// "config/**/*.vue",
// "components/**/*.ts",
// "components/**/*.tsx",
// "components/**/*.vue"
//
// TIP————————————————————————————组件库打包————
// WARN 这里的代码，会生成到 lib 中去？？？
'examples/**/*.ts',
'examples/**/*.tsx',
'examples/**/*.vue',
//
// WARN 这里的代码，会生成到 lib 中去？？？
'packages/**/*.ts',
'packages/**/*.tsx',
'packages/**/*.vue',
// WARN 我想要一种【Lint检查】但不【实际编译】的方法？？？？？？
// 似乎要在测试文件，加上【import '@types/jest';】，才能生效。
// 没找到之前，只能注释这里了。
// 也许需要【EsLint】的检查。
'tests/**/*.ts',
'tests/**/*.tsx',
];
NuxtJs_TsConfig_Helper._exclude = [
'node_modules',
];
NuxtJs_TsConfig_Helper._compilerOptions = {
/**
* target的版本，其实有时候很重要：
* 1.【es2018】 WARN 适配【nuxt.js】
* 2.【es5】 WARN 适配Vue
* 3.【es6】 WARN 其它的一些场合？？？？？？？？？
*/
_target: 'es5',
/**
* target的版本，其实有时候很重要：
* 1.【esnext】 WARN 适配【nuxt.js】
* 2.【es6】 WARN 解决【exports is not defined】的问题？
* 3.【module : esnext】+【lib : es5】的方案。
*/
_module: 'esnext',
_lib: [
'esnext.asynciterable',
'es5',
],
/**
* FIXME 此处，后来发现，NPM项目比较特殊：
* 1.【noEmit = true】，将会使 TypeScript 不生成任何文件。
* 1.【Nuxt.js】或许不需要生成文件。
* 2.但是【NPM项目】必须要生成文件。
*/
// _noEmit : true, // WARN 适配【nuxt.js】
_noEmit: false,
_types: [
// "webpack-env", // WARN 适配【nuxt.js】 ———— 此处，进行隐藏！！！
'@types/node',
'@nuxt/types',
//
// TIP————————————————————————————组件库打包————
//
'webpack-env',
'jest',
],
_paths: {
// FIXME 因为WebStorm的Bug，只能用【单行注释】！！！不然内容被错乱！！！
//
// // WARN 适配【nuxt.js】
// '~/*': [
// './*',
// ],
// // WARN 适配【nuxt.js】
// '@/*': [
// './*',
// ],
//
},
_typeRoots: [
'./types',
],
_resolveJsonModule: true,
};
return NuxtJs_TsConfig_Helper;
}());
/**
*
*/
var TsNode_Helper = /** @class */ (function () {
function TsNode_Helper() {
}
TsNode_Helper._compilerOptions = {
/**
* 1.并没有生效
* 1.建议，改用【手动用 三斜杠】来进行定义。
* 1.但是，手动用【三斜杠】依然没有生效。
* 1.最后，采用【ts-node --files】生效了。
*/
_typeRoots: [
'./node_modules/@types',
'./types',
],
};
return TsNode_Helper;
}());
/**
* 控制是否检查【.d.ts】中的类型错误。
*/
var FullTypeCheck_Helper = /** @class */ (function () {
function FullTypeCheck_Helper() {
}
FullTypeCheck_Helper.checkType_d_ts = false;
return FullTypeCheck_Helper;
}());
/**
* 专门用于，NPM打包、部署，的工具类
*/
var NpmBuild_Helper = /** @class */ (function () {
function NpmBuild_Helper() {
}
/**
* 编译输出文件【总绝对目录】
* 1.默认，undefined，等于【单文件自己的rootDir】
* 2.设定为【某个目标目录】，则所有的生成 【js】、【.js.map】、【.d.ts】、【.d.ts.map】 都会在【保持原有树状结构】的前提下，生成到【某个目标目录】。
*/
// public static readonly _outDir = undefined; // 直接原地生成
// public static readonly _outDir = './dist'; // 迁移到【./dist】再生成
NpmBuild_Helper._outDir = './lib'; // 迁移到【./dist】再生成
//
NpmBuild_Helper._declareCfg = {
/**
* 生成相应的 .d.ts文件。
*/
_declaration: true,
/**
* 生成声明文件的【总绝对输出路径】。
* 1.字符串或undefined。
* 2.【undefined】时，【.d.ts文件】将保持和【js文件】，处于同一目录。
* 3.
*/
// _declarationDir: './my-types',
_declarationDir: undefined,
/**
* 为【.d.ts】文件，生成指向于【.ts源】文件，的SourceMap。
* 1.【使用项目引用】的情况下，强烈建议使用。
*/
_declarationMap: true,
/**
* 只生成【.d.ts】文件。（不生成【js】文件）
*/
_emitDeclarationOnly: false,
};
return NpmBuild_Helper;
}());
/**
* 为【lib-cp】目录，提供
*/
var CpLib_Alias_Helper = /** @class */ (function () {
function CpLib_Alias_Helper() {
}
CpLib_Alias_Helper._paths = {
'@lib-ts/*': ['./lib/sources/*'],
'@lib-cp/*': ['./lib-cp/*'],
};
return CpLib_Alias_Helper;
}());
var GenTsconfigUtil = /** @class */ (function () {
function GenTsconfigUtil() {
// noinspection PointlessBooleanExpressionJS
this.tsConfig = {
// TIP 将以下目录，包括在TypeScript解析之中
'include': __spread(NuxtJs_TsConfig_Helper._include),
// TIP 将以下目录，排除在TypeScript解析之外
'exclude': NuxtJs_TsConfig_Helper._exclude,
'compilerOptions': {
'outDir': NpmBuild_Helper._outDir,
'declaration': NpmBuild_Helper._declareCfg._declaration,
'declarationDir': NpmBuild_Helper._declareCfg._declarationDir,
'declarationMap': NpmBuild_Helper._declareCfg._declarationMap,
'emitDeclarationOnly': NpmBuild_Helper._declareCfg._emitDeclarationOnly,
//
//
//
//
//
//
/**
* TIP 以下的配置，在稳定版的Vue+TypeScript+MyFrameWork之上，于【2019年3月16日20:59:34】又更新了一版。
* TIP 参考资料：
* TIP 1.HstarDoc/TypeScript配置文件tsconfig简析.md at master · hstarorg/HstarDoc - https://github.com/hstarorg/HstarDoc/blob/master/%E5%89%8D%E7%AB%AF%E7%9B%B8%E5%85%B3/TypeScript%E9%85%8D%E7%BD%AE%E6%96%87%E4%BB%B6tsconfig%E7%AE%80%E6%9E%90.md
*/
// "target": "es5",
// TIP 最终编译成的js版本。
'target': NuxtJs_TsConfig_Helper._compilerOptions._target,
// TIP 基础模块。（TIP 此处，需要【>=es5的module】。不然比如【commonjs】会报错：【Uncaught ReferenceError: exports is not defined】）
'module': NuxtJs_TsConfig_Helper._compilerOptions._module,
// TIP 添加的ES语言依赖包
'lib': __spread([
'esnext'
], NuxtJs_TsConfig_Helper._compilerOptions._lib, [
'dom',
'dom.iterable',
'scripthost',
'webworker',
]),
'noEmit': NuxtJs_TsConfig_Helper._compilerOptions._noEmit,
/*这可以对 `this` 上的数据属性进行更严格的推断-1*/
// TIP 启用 --strict相当于启用 --noImplicitAny, --noImplicitThis, --alwaysStrict， --strictBindCallApply， --strictNullChecks和 --strictFunctionTypes和--strictPropertyInitialization。
'strict': true,
/*这可以对 `this` 上的数据属性进行更严格的推断-2*/
/* TIP 这里，暂时不对this 进行强制规范。（避开'this' implicitly has type 'any' because it does not have a type annotation.的错误） */
/* TIP 最新的修改，将this改为super。然后开启this的强制规范。 */
/* TIP 最最新的修改，将 super的调用，修改为 static的调用 */
'noImplicitThis': true,
'jsx': 'preserve',
'importHelpers': true,
/* TIP 此处，注意，setTimeout这种api，在不同ts环境中，也会有表现区别（比如，返回类型完全不一致。）。所以，我们在浏览器环境，设置为classic，而非node*/
/* TIP 此处，默认的vue-cli 3-ts模式，是node。 而且切换为classic后，也不能达到预期效果*/
'moduleResolution': 'node',
/* 启用 vue-class-component 及 vuex-class 需要开启此选项 */
'experimentalDecorators': true,
/* 开启TypeScript反射。（实验性API：元数据反射） */
'emitDecoratorMetadata': true,
/* TIP 启用 vuex-class 需要开启此选项 */
/* WARN Vue版本的Bug，此选项需要关闭。直到Vue最新更新 */
/* TIP 最新版的自定义框架，此选项已可以打开 */
'strictFunctionTypes': true,
'esModuleInterop': true,
'sourceMap': true,
'baseUrl': '.',
/* TIP 开启禁用隐式any的严格（开启后，如果使用any，你必须显式地声明） */
'noImplicitAny': true,
/*严格属性初始化：Vue组件类的属性是否需要初始化*/
/* TIP 仍然强制要求初始化；只是用 ts-ignore 注释 */
/* TIP 此处，为了 vuex的工具使用，将初始化检查，列为非必要 */
/* TIP 最终方案：① 为了Vue组件类每个属性值，都得到初始化（若Vue组件类有一个属性未初始化，则可能会无法数据绑定），这个选项检查，是必要的。
② 对于有些 @Prop选项、@Getter-vuex属性，不能自己初始化必须留空等待框架初始化的，则用 @MyGetter("username") username!: string; 的【!:】方式，告诉ts编译器：此处必定有值。（相对应的，【?:】表示可能有值也可能为undefined。【:】则是一种居中的表现（指不作具体预先判断，具体表现交给tsconfig去进行复查\。）。）*/
'strictPropertyInitialization': true,
// TIP 允许使用非ts文件（重要）
'allowJs': TypeScript_SpeedUp_Helper.tsConfig_JSON._allowJs,
//
// TIP 用TypeScript的配置选项，来让【for-of】在ES5版本下也能获得【兼容性处理】。
// 参考资料：TypeScript 2.3: Downlevel Iteration for ES3/ES5 – 酷辣虫 CoLaBug - https://www.colabug.com/277936.html
'downlevelIteration': true,
// 显示TS的诊断信息
'diagnostics': true,
// TIP 不允许：隐式的返回值声明（或有些代码分支没有返回值）
'noImplicitReturns': true,
// TIP 校验【switch-case】语法，禁止出现多个case穿透的情况（要求强制写break隔开）。（default可以不加，但绝不能穿透）
'noFallthroughCasesInSwitch': true,
// TIP 不允许有，【无法访问的代码】：更加严格的检验。
'allowUnreachableCode': false,
// TIP 用import导入文件时，严格区分【文件名大小写】，不允许文件名大小写混淆。
'forceConsistentCasingInFileNames': true,
// TIP 这个宽松开关，将其打开！！！因为有很多js库的 .d.ts 文件编写比较混乱，无法达到通过严格检查的地步 TIP 更加严格的检查：不允许，从【没有默认导出的文件中】，进行【模块默认导入（import x from 'aaa.tx'）】
'allowSyntheticDefaultImports': true,
// TIP 是否检查，外部引入的第三方库，是否符合类型规范
'skipLibCheck': !FullTypeCheck_Helper.checkType_d_ts,
//
'types': __spread(NuxtJs_TsConfig_Helper._compilerOptions._types),
'paths': __assign(__assign({}, NuxtJs_TsConfig_Helper._compilerOptions._paths), CpLib_Alias_Helper._paths),
'typeRoots': [
// ...NuxtJs_TsConfig_Helper._compilerOptions._typeRoots, 注释掉，因为全部在【includes】选项里，处理了
// ...TsNode_Helper._compilerOptions._typeRoots, 好像并没有起到作用？？？
],
'resolveJsonModule': NuxtJs_TsConfig_Helper._compilerOptions._resolveJsonModule,
'importsNotUsedAsValues': TypeScript_SpeedUp_Helper.tsConfig_JSON._importsNotUsedAsValues,
},
};
}
GenTsconfigUtil.prototype.gen = function () {
console.log('开始生成', 'tsconfig.json文件');
console.log('开始生成', 'tsconfig.json文件');
console.log('开始生成', 'tsconfig.json文件');
console.log('开始生成', 'tsconfig.json文件');
console.log('开始生成', 'tsconfig.json文件');
console.log('开始生成', 'tsconfig.json文件');
require('fs').writeFileSync('tsconfig.json', JSON.stringify(this.tsConfig, null, 2));
};
return GenTsconfigUtil;
}());
new GenTsconfigUtil().gen();
//# sourceMappingURL=gen-tsconfig.js.map