forked from facebook/lexical
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add validate-tsc-types type validation step after build
- Loading branch information
Showing
2 changed files
with
91 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,88 @@ | ||
/** | ||
* Copyright (c) Meta Platforms, Inc. and affiliates. | ||
* | ||
* This source code is licensed under the MIT license found in the | ||
* LICENSE file in the root directory of this source tree. | ||
* | ||
*/ | ||
// @ts-check | ||
'use strict'; | ||
|
||
const fs = require('fs-extra'); | ||
const glob = require('glob'); | ||
const ts = require('typescript'); | ||
|
||
const pretty = process.env.CI !== 'true'; | ||
|
||
/** @type {ts.FormatDiagnosticsHost} */ | ||
const diagnosticsHost = { | ||
getCanonicalFileName: (fn) => fn, | ||
getCurrentDirectory: () => './', | ||
getNewLine: () => '\n', | ||
}; | ||
|
||
/** | ||
* Validate that the published .d.ts types do not have dependencies | ||
* on any private module (currently shared/*). | ||
* | ||
* `process.exit(1)` on failure. | ||
*/ | ||
function validateTscTypes() { | ||
const dtsFilesPattern = './.ts-temp/{lexical,lexical-*}/**/*.d.ts'; | ||
const dtsFiles = glob.sync(dtsFilesPattern); | ||
if (dtsFiles.length === 0) { | ||
console.error( | ||
`Missing ${dtsFilesPattern}, \`npm run build-prod\` or \`npm run build-release\` first`, | ||
); | ||
process.exit(1); | ||
} | ||
/** @type {ts.Diagnostic[]} */ | ||
const diagnostics = []; | ||
for (const fn of dtsFiles) { | ||
// console.log(fn); | ||
const ast = ts.createSourceFile( | ||
fn, | ||
fs.readFileSync(fn, 'utf-8'), | ||
ts.ScriptTarget.Latest, | ||
); | ||
const checkSpecifier = (/** @type {ts.Node | undefined} */ node) => { | ||
if (!node || node.kind !== ts.SyntaxKind.StringLiteral) { | ||
return; | ||
} | ||
const specifier = /** @type {import('typescript').StringLiteral} */ ( | ||
node | ||
); | ||
if (/^shared(\/|$)/.test(specifier.text)) { | ||
const start = specifier.getStart(ast); | ||
diagnostics.push({ | ||
category: ts.DiagnosticCategory.Error, | ||
code: Infinity, | ||
file: ast, | ||
length: specifier.getEnd() - start, | ||
messageText: `Published .d.ts files must not import private module '${specifier.text}'.`, | ||
start, | ||
}); | ||
} | ||
}; | ||
ast.forEachChild((node) => { | ||
if (node.kind === ts.SyntaxKind.ExportDeclaration) { | ||
const exportNode = | ||
/** @type {import('typescript').ExportDeclaration} */ (node); | ||
checkSpecifier(exportNode.moduleSpecifier); | ||
} else if (node.kind === ts.SyntaxKind.ImportDeclaration) { | ||
const importNode = | ||
/** @type {import('typescript').ImportDeclaration} */ (node); | ||
checkSpecifier(importNode.moduleSpecifier); | ||
} | ||
}); | ||
} | ||
if (diagnostics.length > 0) { | ||
const msg = ( | ||
pretty ? ts.formatDiagnosticsWithColorAndContext : ts.formatDiagnostics | ||
)(diagnostics, diagnosticsHost); | ||
console.error(msg.replace(/ TSInfinity:/g, ':')); | ||
process.exit(1); | ||
} | ||
} | ||
|
||
validateTscTypes(); |