Add auto-generation of TypeScript definitions on build#38990

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
huntie wants to merge 1 commit into from
Closed

Add auto-generation of TypeScript definitions on build #38990

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions flow-typed/npm/@tsconfig/node18_v1.x.x.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
/**
* 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.
*
* @flow
* @format
*/

declare module '@tsconfig/node18/tsconfig.json' {
declare module.exports: any;
}
56 changes: 56 additions & 0 deletions flow-typed/npm/typescript_v5.x.x.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
/**
* 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.
*
* @flow
* @format
*/

declare module 'typescript' {
declare enum ModuleResolutionKind {
Classic = 'Classic',
NodeJs = 'NodeJs',
Node10 = 'Node10',
Node16 = 'Node16',
NodeNext = 'NodeNext',
Bundler = 'Bundler',
}

declare type SourceFile = $ReadOnly<{
fileName: string,
text: string,
...
}>;

declare type Diagnostic = $ReadOnly<{
file?: SourceFile,
start?: number,
messageText: string,
...
}>;

declare type EmitResult = $ReadOnly<{
diagnostics: Array<Diagnostic>,
...
}>;

declare type Program = $ReadOnly<{
emit: () => EmitResult,
...
}>;

declare type TypeScriptAPI = {
createProgram(files: Array<string>, compilerOptions: Object): Program,
flattenDiagnosticMessageText: (...messageText: Array<string>) => string,
getLineAndCharacterOfPosition(
file: SourceFile,
start?: number,
): $ReadOnly<{line: number, character: number}>,
ModuleResolutionKind: typeof ModuleResolutionKind,
...
};

declare module.exports: TypeScriptAPI;
}
2 changes: 2 additions & 0 deletions package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -57,6 +57,7 @@
"@pkgjs/parseargs": "^0.11.0",
"@react-native/metro-babel-transformer": "^0.73.11",
"@react-native/metro-config": "^0.73.0",
"@tsconfig/node18": "1.0.1",
"@types/react": "^18.0.18",
"@typescript-eslint/parser": "^5.57.1",
"async": "^3.2.2",
Expand All@@ -81,6 +82,7 @@
"eslint-plugin-react-native": "^4.0.0",
"eslint-plugin-redundant-undefined": "^0.4.0",
"eslint-plugin-relay": "^1.8.3",
"flow-api-translator": "0.15.0",
"flow-bin": "^0.214.0",
"glob": "^7.1.1",
"hermes-eslint": "0.15.0",
Expand Down
2 changes: 1 addition & 1 deletion packages/dev-middleware/src/index.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,4 +17,4 @@ if (!process.env.BUILD_EXCLUDE_BABEL_REGISTER) {
require('../../../scripts/build/babel-register').registerForMonorepo();
}

module.exports = require('./index.flow');
export * from './index.flow';
44 changes: 44 additions & 0 deletions scripts/build/babel/node.config.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
/**
* 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.
*
* @flow
* @format
* @oncall react_native
*/

/*::
import type {BabelCoreOptions} from '@babel/core';
*/

const TARGET_NODE_VERSION = '18';

const config /*: BabelCoreOptions */ = {
presets: [
'@babel/preset-flow',
[
'@babel/preset-env',
{
targets: {
node: TARGET_NODE_VERSION,
},
},
],
],
plugins: [
[
'transform-define',
{
'process.env.BUILD_EXCLUDE_BABEL_REGISTER': true,
},
],
[
'minify-dead-code-elimination',
{keepFnName: true, keepFnArgs: true, keepClassName: true},
],
],
};

module.exports = config;
156 changes: 123 additions & 33 deletions scripts/build/build.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,14 +12,22 @@
const babel = require('@babel/core');
const {parseArgs} = require('@pkgjs/parseargs');
const chalk = require('chalk');
const translate = require('flow-api-translator');
const glob = require('glob');
const micromatch = require('micromatch');
const fs = require('fs');
const {promises: fs} = require('fs');
const path = require('path');
const prettier = require('prettier');
const {buildConfig, getBabelConfig} = require('./config');

const PACKAGES_DIR /*: string */ = path.resolve(__dirname, '../../packages');
const ts = require('typescript');
const {
buildConfig,
getBabelConfig,
getBuildOptions,
getTypeScriptCompilerOptions,
} = require('./config');

const REPO_ROOT = path.resolve(__dirname, '../..');
const PACKAGES_DIR /*: string */ = path.join(REPO_ROOT, 'packages');
const SRC_DIR = 'src';
const BUILD_DIR = 'dist';
const JS_FILES_PATTERN = '**/*.js';
Expand All@@ -32,7 +40,7 @@ const config = {
},
};

function build() {
async function build() {
const {
positionals: packageNames,
values: {help},
Expand All@@ -53,35 +61,48 @@ function build() {

console.log('\n' + chalk.bold.inverse('Building packages') + '\n');

if (packageNames.length) {
packageNames
.filter(packageName => packageName in buildConfig.packages)
.forEach(buildPackage);
} else {
Object.keys(buildConfig.packages).forEach(buildPackage);
const packagesToBuild = packageNames.length
? packageNames.filter(packageName => packageName in buildConfig.packages)
: Object.keys(buildConfig.packages);

for (const packageName of packagesToBuild) {
await buildPackage(packageName);
}

process.exitCode = 0;
}

function buildPackage(packageName /*: string */) {
async function buildPackage(packageName /*: string */) {
const {emitTypeScriptDefs} = getBuildOptions(packageName);
const files = glob.sync(
path.resolve(PACKAGES_DIR, packageName, SRC_DIR, '**/*'),
{nodir: true},
);
const packageJsonPath = path.join(PACKAGES_DIR, packageName, 'package.json');

process.stdout.write(
`${packageName} ${chalk.dim('.').repeat(72 - packageName.length)} `,
);
files.forEach(file => buildFile(path.normalize(file), true));
rewritePackageExports(packageJsonPath);

// Build all files matched for package
for (const file of files) {
await buildFile(path.normalize(file), true);
}

// Validate program for emitted .d.ts files
if (emitTypeScriptDefs) {
validateTypeScriptDefs(packageName);
}

// Rewrite package.json "exports" field (src -> dist)
await rewritePackageExports(packageName);

process.stdout.write(chalk.reset.inverse.bold.green(' DONE ') + '\n');
}

function buildFile(file /*: string */, silent /*: boolean */ = false) {
async function buildFile(file /*: string */, silent /*: boolean */ = false) {
const packageName = getPackageName(file);
const buildPath = getBuildPath(file);
const {emitFlowDefs, emitTypeScriptDefs} = getBuildOptions(packageName);

const logResult = ({copied, desc} /*: {copied: boolean, desc?: string} */) =>
silent ||
Expand All@@ -97,24 +118,43 @@ function buildFile(file /*: string */, silent /*: boolean */ = false) {
return;
}

fs.mkdirSync(path.dirname(buildPath), {recursive: true});
await fs.mkdir(path.dirname(buildPath), {recursive: true});

if (!micromatch.isMatch(file, JS_FILES_PATTERN)) {
fs.copyFileSync(file, buildPath);
await fs.copyFile(file, buildPath);
logResult({copied: true, desc: 'copy'});
} else {
const transformed = prettier.format(
babel.transformFileSync(file, getBabelConfig(packageName)).code,
{parser: 'babel'},
);
fs.writeFileSync(buildPath, transformed);
return;
}

if (/@flow/.test(fs.readFileSync(file, 'utf-8'))) {
fs.copyFileSync(file, buildPath + '.flow');
}
const source = await fs.readFile(file, 'utf-8');
const prettierConfig = {parser: 'babel'};

logResult({copied: true});
// Transform source file using Babel
const transformed = prettier.format(
(await babel.transformFileAsync(file, getBabelConfig(packageName))).code,
prettierConfig,
);
await fs.writeFile(buildPath, transformed);

// Translate source Flow types for each type definition target
if (/@flow/.test(source)) {
await Promise.all([
emitFlowDefs
? fs.writeFile(
buildPath + '.flow',
await translate.translateFlowToFlowDef(source, prettierConfig),
)
: null,
emitTypeScriptDefs
? fs.writeFile(
buildPath.replace(/\.js$/, '') + '.d.ts',
await translate.translateFlowToTSDef(source, prettierConfig),
)
: null,
]);
}

logResult({copied: true});
}

function getPackageName(file /*: string */) /*: string */ {
Expand All@@ -130,16 +170,22 @@ function getBuildPath(file /*: string */) /*: string */ {
);
}

function rewritePackageExports(packageJsonPath /*: string */) {
const pkg = JSON.parse(fs.readFileSync(packageJsonPath, {encoding: 'utf8'}));
async function rewritePackageExports(packageName /*: string */) {
const packageJsonPath = path.join(PACKAGES_DIR, packageName, 'package.json');
const pkg = JSON.parse(await fs.readFile(packageJsonPath, 'utf8'));

if (pkg.exports == null) {
return;
throw new Error(
packageName +
' does not define an "exports" field in its package.json. As part ' +
'of the build setup, this field must be used in order to rewrite ' +
'paths to built files in production.',
);
}

pkg.exports = rewriteExportsField(pkg.exports);

fs.writeFileSync(
await fs.writeFile(
packageJsonPath,
prettier.format(JSON.stringify(pkg), {parser: 'json'}),
);
Expand DownExpand Up@@ -173,6 +219,49 @@ function rewriteExportsTarget(target /*: string */) /*: string */ {
return target.replace('./' + SRC_DIR + '/', './' + BUILD_DIR + '/');
}

function validateTypeScriptDefs(packageName /*: string */) {
const files = glob.sync(
path.resolve(PACKAGES_DIR, packageName, BUILD_DIR, '**/*.d.ts'),
);
const compilerOptions = {
...getTypeScriptCompilerOptions(packageName),
noEmit: true,
skipLibCheck: false,
};
const program = ts.createProgram(files, compilerOptions);
const emitResult = program.emit();

if (emitResult.diagnostics.length) {
for (const diagnostic of emitResult.diagnostics) {
if (diagnostic.file != null) {
let {line, character} = ts.getLineAndCharacterOfPosition(
diagnostic.file,
diagnostic.start,
);
let message = ts.flattenDiagnosticMessageText(
diagnostic.messageText,
'\n',
);
console.log(
// $FlowIssue[incompatible-use] Type refined above
`${diagnostic.file.fileName} (${line + 1},${
character + 1
}): ${message}`,
);
} else {
console.log(
ts.flattenDiagnosticMessageText(diagnostic.messageText, '\n'),
);
}
}

throw new Error(
'Failing build because TypeScript errors were encountered for ' +
'generated type definitions.',
);
}
}

module.exports = {
buildFile,
getBuildPath,
Expand All@@ -182,5 +271,6 @@ module.exports = {
};

if (require.main === module) {
build();
// eslint-disable-next-line no-void
void build();
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Add auto-generation of TypeScript definitions on build#38990

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

huntie
wants to merge
1
commit into

from

 Closed


Add auto-generation of TypeScript definitions on build
#38990
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


13 changes: 13 additions & 0 deletions
flow-typed/npm/@tsconfig/node18_v1.x.x.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
/**
 * 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.
 *
 * @flow
 * @format
 */

declare module '@tsconfig/node18/tsconfig.json' {
 declare module.exports: any;
}

56 changes: 56 additions & 0 deletions
flow-typed/npm/typescript_v5.x.x.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
/**
 * 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.
 *
 * @flow
 * @format
 */

declare module 'typescript' {
 declare enum ModuleResolutionKind {
 Classic = 'Classic',
 NodeJs = 'NodeJs',
 Node10 = 'Node10',
 Node16 = 'Node16',
 NodeNext = 'NodeNext',
 Bundler = 'Bundler',
 }

 declare type SourceFile = $ReadOnly<{
 fileName: string,
 text: string,
 ...
 }>;

 declare type Diagnostic = $ReadOnly<{
 file?: SourceFile,
 start?: number,
 messageText: string,
 ...
 }>;

 declare type EmitResult = $ReadOnly<{
 diagnostics: Array<Diagnostic>,
 ...
 }>;

 declare type Program = $ReadOnly<{
 emit: () => EmitResult,
 ...
 }>;

 declare type TypeScriptAPI = {
 createProgram(files: Array<string>, compilerOptions: Object): Program,
 flattenDiagnosticMessageText: (...messageText: Array<string>) => string,
 getLineAndCharacterOfPosition(
 file: SourceFile,
 start?: number,
 ): $ReadOnly<{line: number, character: number}>,
 ModuleResolutionKind: typeof ModuleResolutionKind,
 ...
 };

 declare module.exports: TypeScriptAPI;
}

2 changes: 2 additions & 0 deletions
package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,6 +57,7 @@
 "@pkgjs/parseargs": "^0.11.0",
 "@react-native/metro-babel-transformer": "^0.73.11",
 "@react-native/metro-config": "^0.73.0",
 "@tsconfig/node18": "1.0.1",
 "@types/react": "^18.0.18",
 "@typescript-eslint/parser": "^5.57.1",
 "async": "^3.2.2",
Expand All@@ -81,6 +82,7 @@
 "eslint-plugin-react-native": "^4.0.0",
 "eslint-plugin-redundant-undefined": "^0.4.0",
 "eslint-plugin-relay": "^1.8.3",
 "flow-api-translator": "0.15.0",
 "flow-bin": "^0.214.0",
 "glob": "^7.1.1",
 "hermes-eslint": "0.15.0",
Expand Down

2 changes: 1 addition & 1 deletion
packages/dev-middleware/src/index.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,4 +17,4 @@ if (!process.env.BUILD_EXCLUDE_BABEL_REGISTER) {
 require('../../../scripts/build/babel-register').registerForMonorepo();
}

module.exports = require('./index.flow');
export * from './index.flow';

44 changes: 44 additions & 0 deletions
scripts/build/babel/node.config.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
/**
 * 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.
 *
 * @flow
 * @format
 * @oncall react_native
 */

/*::
import type {BabelCoreOptions} from '@babel/core';
*/

const TARGET_NODE_VERSION = '18';

const config /*: BabelCoreOptions */ = {
 presets: [
 '@babel/preset-flow',
 [
 '@babel/preset-env',
 {
 targets: {
 node: TARGET_NODE_VERSION,
 },
 },
 ],
 ],
 plugins: [
 [
 'transform-define',
 {
 'process.env.BUILD_EXCLUDE_BABEL_REGISTER': true,
 },
 ],
 [
 'minify-dead-code-elimination',
 {keepFnName: true, keepFnArgs: true, keepClassName: true},
 ],
 ],
};

module.exports = config;

156 changes: 123 additions & 33 deletions
scripts/build/build.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,14 +12,22 @@
const babel = require('@babel/core');
const {parseArgs} = require('@pkgjs/parseargs');
const chalk = require('chalk');
const translate = require('flow-api-translator');
const glob = require('glob');
const micromatch = require('micromatch');
const fs = require('fs');
const {promises: fs} = require('fs');
const path = require('path');
const prettier = require('prettier');
const {buildConfig, getBabelConfig} = require('./config');

const PACKAGES_DIR /*: string */ = path.resolve(__dirname, '../../packages');
const ts = require('typescript');
const {
 buildConfig,
 getBabelConfig,
 getBuildOptions,
 getTypeScriptCompilerOptions,
} = require('./config');

const REPO_ROOT = path.resolve(__dirname, '../..');
const PACKAGES_DIR /*: string */ = path.join(REPO_ROOT, 'packages');
const SRC_DIR = 'src';
const BUILD_DIR = 'dist';
const JS_FILES_PATTERN = '**/*.js';
Expand All@@ -32,7 +40,7 @@ const config = {
 },
};

function build() {
async function build() {
 const {
 positionals: packageNames,
 values: {help},
Expand All@@ -53,35 +61,48 @@ function build() {

 console.log('\n' + chalk.bold.inverse('Building packages') + '\n');

if (packageNames.length) {
 packageNames
 .filter(packageName => packageName in buildConfig.packages)
 .forEach(buildPackage);
} else {
Object.keys(buildConfig.packages).forEach(buildPackage);
const packagesToBuild = packageNames.length
? packageNames.filter(packageName => packageName in buildConfig.packages)
: Object.keys(buildConfig.packages);

for (const packageName of packagesToBuild) {
await buildPackage(packageName);
 }

 process.exitCode = 0;
}

function buildPackage(packageName /*: string */) {
async function buildPackage(packageName /*: string */) {
 const {emitTypeScriptDefs} = getBuildOptions(packageName);
 const files = glob.sync(
 path.resolve(PACKAGES_DIR, packageName, SRC_DIR, '**/*'),
 {nodir: true},
 );
 const packageJsonPath = path.join(PACKAGES_DIR, packageName, 'package.json');

 process.stdout.write(
 `${packageName} ${chalk.dim('.').repeat(72 - packageName.length)} `,
 );
 files.forEach(file => buildFile(path.normalize(file), true));
 rewritePackageExports(packageJsonPath);

 // Build all files matched for package
 for (const file of files) {
 await buildFile(path.normalize(file), true);
 }

 // Validate program for emitted .d.ts files
 if (emitTypeScriptDefs) {
 validateTypeScriptDefs(packageName);
 }

 // Rewrite package.json "exports" field (src -> dist)
 await rewritePackageExports(packageName);

 process.stdout.write(chalk.reset.inverse.bold.green(' DONE ') + '\n');
}

function buildFile(file /*: string */, silent /*: boolean */ = false) {
async function buildFile(file /*: string */, silent /*: boolean */ = false) {
 const packageName = getPackageName(file);
 const buildPath = getBuildPath(file);
 const {emitFlowDefs, emitTypeScriptDefs} = getBuildOptions(packageName);

 const logResult = ({copied, desc} /*: {copied: boolean, desc?: string} */) =>
 silent ||
Expand All@@ -97,24 +118,43 @@ function buildFile(file /*: string */, silent /*: boolean */ = false) {
 return;
 }

 fs.mkdirSync(path.dirname(buildPath), {recursive: true});
await fs.mkdir(path.dirname(buildPath), {recursive: true});

 if (!micromatch.isMatch(file, JS_FILES_PATTERN)) {
 fs.copyFileSync(file, buildPath);
await fs.copyFile(file, buildPath);
 logResult({copied: true, desc: 'copy'});
 } else {
 const transformed = prettier.format(
 babel.transformFileSync(file, getBabelConfig(packageName)).code,
 {parser: 'babel'},
 );
 fs.writeFileSync(buildPath, transformed);
 return;
 }

 if (/@flow/.test(fs.readFileSync(file, 'utf-8'))) {
 fs.copyFileSync(file, buildPath + '.flow');
 }
 const source = await fs.readFile(file, 'utf-8');
 const prettierConfig = {parser: 'babel'};

 logResult({copied: true});
 // Transform source file using Babel
 const transformed = prettier.format(
 (await babel.transformFileAsync(file, getBabelConfig(packageName))).code,
 prettierConfig,
 );
 await fs.writeFile(buildPath, transformed);

 // Translate source Flow types for each type definition target
 if (/@flow/.test(source)) {
 await Promise.all([
 emitFlowDefs
 ? fs.writeFile(
 buildPath + '.flow',
 await translate.translateFlowToFlowDef(source, prettierConfig),
 )
 : null,
 emitTypeScriptDefs
 ? fs.writeFile(
 buildPath.replace(/\.js$/, '') + '.d.ts',
 await translate.translateFlowToTSDef(source, prettierConfig),
 )
 : null,
 ]);
 }

 logResult({copied: true});
}

function getPackageName(file /*: string */) /*: string */ {
Expand All@@ -130,16 +170,22 @@ function getBuildPath(file /*: string */) /*: string */ {
 );
}

function rewritePackageExports(packageJsonPath /*: string */) {
 const pkg = JSON.parse(fs.readFileSync(packageJsonPath, {encoding: 'utf8'}));
async function rewritePackageExports(packageName /*: string */) {
 const packageJsonPath = path.join(PACKAGES_DIR, packageName, 'package.json');
 const pkg = JSON.parse(await fs.readFile(packageJsonPath, 'utf8'));

 if (pkg.exports == null) {
 return;
 throw new Error(
 packageName +
 ' does not define an "exports" field in its package.json. As part ' +
 'of the build setup, this field must be used in order to rewrite ' +
 'paths to built files in production.',
 );
 }

 pkg.exports = rewriteExportsField(pkg.exports);

 fs.writeFileSync(
await fs.writeFile(
 packageJsonPath,
 prettier.format(JSON.stringify(pkg), {parser: 'json'}),
 );
Expand DownExpand Up@@ -173,6 +219,49 @@ function rewriteExportsTarget(target /*: string */) /*: string */ {
 return target.replace('./' + SRC_DIR + '/', './' + BUILD_DIR + '/');
}

function validateTypeScriptDefs(packageName /*: string */) {
 const files = glob.sync(
 path.resolve(PACKAGES_DIR, packageName, BUILD_DIR, '**/*.d.ts'),
 );
 const compilerOptions = {
 ...getTypeScriptCompilerOptions(packageName),
 noEmit: true,
 skipLibCheck: false,
 };
 const program = ts.createProgram(files, compilerOptions);
 const emitResult = program.emit();

 if (emitResult.diagnostics.length) {
 for (const diagnostic of emitResult.diagnostics) {
 if (diagnostic.file != null) {
 let {line, character} = ts.getLineAndCharacterOfPosition(
 diagnostic.file,
 diagnostic.start,
 );
 let message = ts.flattenDiagnosticMessageText(
 diagnostic.messageText,
 '\n',
 );
 console.log(
 // $FlowIssue[incompatible-use] Type refined above
 `${diagnostic.file.fileName} (${line + 1},${
 character + 1
 }): ${message}`,
 );
 } else {
 console.log(
 ts.flattenDiagnosticMessageText(diagnostic.messageText, '\n'),
 );
 }
 }

 throw new Error(
 'Failing build because TypeScript errors were encountered for ' +
 'generated type definitions.',
 );
 }
}

module.exports = {
 buildFile,
 getBuildPath,
Expand All@@ -182,5 +271,6 @@ module.exports = {
};

if (require.main === module) {
 build();
 // eslint-disable-next-line no-void
 void build();
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Add auto-generation of TypeScript definitions on build#38990

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

huntie
wants to merge
1
commit into

from

 Closed


Add auto-generation of TypeScript definitions on build
#38990
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


13 changes: 13 additions & 0 deletions
flow-typed/npm/@tsconfig/node18_v1.x.x.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
/**
 * 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.
 *
 * @flow
 * @format
 */

declare module '@tsconfig/node18/tsconfig.json' {
 declare module.exports: any;
}

56 changes: 56 additions & 0 deletions
flow-typed/npm/typescript_v5.x.x.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
/**
 * 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.
 *
 * @flow
 * @format
 */

declare module 'typescript' {
 declare enum ModuleResolutionKind {
 Classic = 'Classic',
 NodeJs = 'NodeJs',
 Node10 = 'Node10',
 Node16 = 'Node16',
 NodeNext = 'NodeNext',
 Bundler = 'Bundler',
 }

 declare type SourceFile = $ReadOnly<{
 fileName: string,
 text: string,
 ...
 }>;

 declare type Diagnostic = $ReadOnly<{
 file?: SourceFile,
 start?: number,
 messageText: string,
 ...
 }>;

 declare type EmitResult = $ReadOnly<{
 diagnostics: Array<Diagnostic>,
 ...
 }>;

 declare type Program = $ReadOnly<{
 emit: () => EmitResult,
 ...
 }>;

 declare type TypeScriptAPI = {
 createProgram(files: Array<string>, compilerOptions: Object): Program,
 flattenDiagnosticMessageText: (...messageText: Array<string>) => string,
 getLineAndCharacterOfPosition(
 file: SourceFile,
 start?: number,
 ): $ReadOnly<{line: number, character: number}>,
 ModuleResolutionKind: typeof ModuleResolutionKind,
 ...
 };

 declare module.exports: TypeScriptAPI;
}

2 changes: 2 additions & 0 deletions
package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,6 +57,7 @@
 "@pkgjs/parseargs": "^0.11.0",
 "@react-native/metro-babel-transformer": "^0.73.11",
 "@react-native/metro-config": "^0.73.0",
 "@tsconfig/node18": "1.0.1",
 "@types/react": "^18.0.18",
 "@typescript-eslint/parser": "^5.57.1",
 "async": "^3.2.2",
Expand All@@ -81,6 +82,7 @@
 "eslint-plugin-react-native": "^4.0.0",
 "eslint-plugin-redundant-undefined": "^0.4.0",
 "eslint-plugin-relay": "^1.8.3",
 "flow-api-translator": "0.15.0",
 "flow-bin": "^0.214.0",
 "glob": "^7.1.1",
 "hermes-eslint": "0.15.0",
Expand Down

2 changes: 1 addition & 1 deletion
packages/dev-middleware/src/index.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,4 +17,4 @@ if (!process.env.BUILD_EXCLUDE_BABEL_REGISTER) {
 require('../../../scripts/build/babel-register').registerForMonorepo();
}

module.exports = require('./index.flow');
export * from './index.flow';

44 changes: 44 additions & 0 deletions
scripts/build/babel/node.config.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
/**
 * 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.
 *
 * @flow
 * @format
 * @oncall react_native
 */

/*::
import type {BabelCoreOptions} from '@babel/core';
*/

const TARGET_NODE_VERSION = '18';

const config /*: BabelCoreOptions */ = {
 presets: [
 '@babel/preset-flow',
 [
 '@babel/preset-env',
 {
 targets: {
 node: TARGET_NODE_VERSION,
 },
 },
 ],
 ],
 plugins: [
 [
 'transform-define',
 {
 'process.env.BUILD_EXCLUDE_BABEL_REGISTER': true,
 },
 ],
 [
 'minify-dead-code-elimination',
 {keepFnName: true, keepFnArgs: true, keepClassName: true},
 ],
 ],
};

module.exports = config;

156 changes: 123 additions & 33 deletions
scripts/build/build.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,14 +12,22 @@
const babel = require('@babel/core');
const {parseArgs} = require('@pkgjs/parseargs');
const chalk = require('chalk');
const translate = require('flow-api-translator');
const glob = require('glob');
const micromatch = require('micromatch');
const fs = require('fs');
const {promises: fs} = require('fs');
const path = require('path');
const prettier = require('prettier');
const {buildConfig, getBabelConfig} = require('./config');

const PACKAGES_DIR /*: string */ = path.resolve(__dirname, '../../packages');
const ts = require('typescript');
const {
 buildConfig,
 getBabelConfig,
 getBuildOptions,
 getTypeScriptCompilerOptions,
} = require('./config');

const REPO_ROOT = path.resolve(__dirname, '../..');
const PACKAGES_DIR /*: string */ = path.join(REPO_ROOT, 'packages');
const SRC_DIR = 'src';
const BUILD_DIR = 'dist';
const JS_FILES_PATTERN = '**/*.js';
Expand All@@ -32,7 +40,7 @@ const config = {
 },
};

function build() {
async function build() {
 const {
 positionals: packageNames,
 values: {help},
Expand All@@ -53,35 +61,48 @@ function build() {

 console.log('\n' + chalk.bold.inverse('Building packages') + '\n');

if (packageNames.length) {
 packageNames
 .filter(packageName => packageName in buildConfig.packages)
 .forEach(buildPackage);
} else {
Object.keys(buildConfig.packages).forEach(buildPackage);
const packagesToBuild = packageNames.length
? packageNames.filter(packageName => packageName in buildConfig.packages)
: Object.keys(buildConfig.packages);

for (const packageName of packagesToBuild) {
await buildPackage(packageName);
 }

 process.exitCode = 0;
}

function buildPackage(packageName /*: string */) {
async function buildPackage(packageName /*: string */) {
 const {emitTypeScriptDefs} = getBuildOptions(packageName);
 const files = glob.sync(
 path.resolve(PACKAGES_DIR, packageName, SRC_DIR, '**/*'),
 {nodir: true},
 );
 const packageJsonPath = path.join(PACKAGES_DIR, packageName, 'package.json');

 process.stdout.write(
 `${packageName} ${chalk.dim('.').repeat(72 - packageName.length)} `,
 );
 files.forEach(file => buildFile(path.normalize(file), true));
 rewritePackageExports(packageJsonPath);

 // Build all files matched for package
 for (const file of files) {
 await buildFile(path.normalize(file), true);
 }

 // Validate program for emitted .d.ts files
 if (emitTypeScriptDefs) {
 validateTypeScriptDefs(packageName);
 }

 // Rewrite package.json "exports" field (src -> dist)
 await rewritePackageExports(packageName);

 process.stdout.write(chalk.reset.inverse.bold.green(' DONE ') + '\n');
}

function buildFile(file /*: string */, silent /*: boolean */ = false) {
async function buildFile(file /*: string */, silent /*: boolean */ = false) {
 const packageName = getPackageName(file);
 const buildPath = getBuildPath(file);
 const {emitFlowDefs, emitTypeScriptDefs} = getBuildOptions(packageName);

 const logResult = ({copied, desc} /*: {copied: boolean, desc?: string} */) =>
 silent ||
Expand All@@ -97,24 +118,43 @@ function buildFile(file /*: string */, silent /*: boolean */ = false) {
 return;
 }

 fs.mkdirSync(path.dirname(buildPath), {recursive: true});
await fs.mkdir(path.dirname(buildPath), {recursive: true});

 if (!micromatch.isMatch(file, JS_FILES_PATTERN)) {
 fs.copyFileSync(file, buildPath);
await fs.copyFile(file, buildPath);
 logResult({copied: true, desc: 'copy'});
 } else {
 const transformed = prettier.format(
 babel.transformFileSync(file, getBabelConfig(packageName)).code,
 {parser: 'babel'},
 );
 fs.writeFileSync(buildPath, transformed);
 return;
 }

 if (/@flow/.test(fs.readFileSync(file, 'utf-8'))) {
 fs.copyFileSync(file, buildPath + '.flow');
 }
 const source = await fs.readFile(file, 'utf-8');
 const prettierConfig = {parser: 'babel'};

 logResult({copied: true});
 // Transform source file using Babel
 const transformed = prettier.format(
 (await babel.transformFileAsync(file, getBabelConfig(packageName))).code,
 prettierConfig,
 );
 await fs.writeFile(buildPath, transformed);

 // Translate source Flow types for each type definition target
 if (/@flow/.test(source)) {
 await Promise.all([
 emitFlowDefs
 ? fs.writeFile(
 buildPath + '.flow',
 await translate.translateFlowToFlowDef(source, prettierConfig),
 )
 : null,
 emitTypeScriptDefs
 ? fs.writeFile(
 buildPath.replace(/\.js$/, '') + '.d.ts',
 await translate.translateFlowToTSDef(source, prettierConfig),
 )
 : null,
 ]);
 }

 logResult({copied: true});
}

function getPackageName(file /*: string */) /*: string */ {
Expand All@@ -130,16 +170,22 @@ function getBuildPath(file /*: string */) /*: string */ {
 );
}

function rewritePackageExports(packageJsonPath /*: string */) {
 const pkg = JSON.parse(fs.readFileSync(packageJsonPath, {encoding: 'utf8'}));
async function rewritePackageExports(packageName /*: string */) {
 const packageJsonPath = path.join(PACKAGES_DIR, packageName, 'package.json');
 const pkg = JSON.parse(await fs.readFile(packageJsonPath, 'utf8'));

 if (pkg.exports == null) {
 return;
 throw new Error(
 packageName +
 ' does not define an "exports" field in its package.json. As part ' +
 'of the build setup, this field must be used in order to rewrite ' +
 'paths to built files in production.',
 );
 }

 pkg.exports = rewriteExportsField(pkg.exports);

 fs.writeFileSync(
await fs.writeFile(
 packageJsonPath,
 prettier.format(JSON.stringify(pkg), {parser: 'json'}),
 );
Expand DownExpand Up@@ -173,6 +219,49 @@ function rewriteExportsTarget(target /*: string */) /*: string */ {
 return target.replace('./' + SRC_DIR + '/', './' + BUILD_DIR + '/');
}

function validateTypeScriptDefs(packageName /*: string */) {
 const files = glob.sync(
 path.resolve(PACKAGES_DIR, packageName, BUILD_DIR, '**/*.d.ts'),
 );
 const compilerOptions = {
 ...getTypeScriptCompilerOptions(packageName),
 noEmit: true,
 skipLibCheck: false,
 };
 const program = ts.createProgram(files, compilerOptions);
 const emitResult = program.emit();

 if (emitResult.diagnostics.length) {
 for (const diagnostic of emitResult.diagnostics) {
 if (diagnostic.file != null) {
 let {line, character} = ts.getLineAndCharacterOfPosition(
 diagnostic.file,
 diagnostic.start,
 );
 let message = ts.flattenDiagnosticMessageText(
 diagnostic.messageText,
 '\n',
 );
 console.log(
 // $FlowIssue[incompatible-use] Type refined above
 `${diagnostic.file.fileName} (${line + 1},${
 character + 1
 }): ${message}`,
 );
 } else {
 console.log(
 ts.flattenDiagnosticMessageText(diagnostic.messageText, '\n'),
 );
 }
 }

 throw new Error(
 'Failing build because TypeScript errors were encountered for ' +
 'generated type definitions.',
 );
 }
}

module.exports = {
 buildFile,
 getBuildPath,
Expand All@@ -182,5 +271,6 @@ module.exports = {
};

if (require.main === module) {
 build();
 // eslint-disable-next-line no-void
 void build();
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Add auto-generation of TypeScript definitions on build#38990

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

huntie
wants to merge
1
commit into

from

 Closed


Add auto-generation of TypeScript definitions on build
#38990
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


13 changes: 13 additions & 0 deletions
flow-typed/npm/@tsconfig/node18_v1.x.x.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
/**
 * 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.
 *
 * @flow
 * @format
 */

declare module '@tsconfig/node18/tsconfig.json' {
 declare module.exports: any;
}

56 changes: 56 additions & 0 deletions
flow-typed/npm/typescript_v5.x.x.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
/**
 * 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.
 *
 * @flow
 * @format
 */

declare module 'typescript' {
 declare enum ModuleResolutionKind {
 Classic = 'Classic',
 NodeJs = 'NodeJs',
 Node10 = 'Node10',
 Node16 = 'Node16',
 NodeNext = 'NodeNext',
 Bundler = 'Bundler',
 }

 declare type SourceFile = $ReadOnly<{
 fileName: string,
 text: string,
 ...
 }>;

 declare type Diagnostic = $ReadOnly<{
 file?: SourceFile,
 start?: number,
 messageText: string,
 ...
 }>;

 declare type EmitResult = $ReadOnly<{
 diagnostics: Array<Diagnostic>,
 ...
 }>;

 declare type Program = $ReadOnly<{
 emit: () => EmitResult,
 ...
 }>;

 declare type TypeScriptAPI = {
 createProgram(files: Array<string>, compilerOptions: Object): Program,
 flattenDiagnosticMessageText: (...messageText: Array<string>) => string,
 getLineAndCharacterOfPosition(
 file: SourceFile,
 start?: number,
 ): $ReadOnly<{line: number, character: number}>,
 ModuleResolutionKind: typeof ModuleResolutionKind,
 ...
 };

 declare module.exports: TypeScriptAPI;
}

2 changes: 2 additions & 0 deletions
package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,6 +57,7 @@
 "@pkgjs/parseargs": "^0.11.0",
 "@react-native/metro-babel-transformer": "^0.73.11",
 "@react-native/metro-config": "^0.73.0",
 "@tsconfig/node18": "1.0.1",
 "@types/react": "^18.0.18",
 "@typescript-eslint/parser": "^5.57.1",
 "async": "^3.2.2",
Expand All@@ -81,6 +82,7 @@
 "eslint-plugin-react-native": "^4.0.0",
 "eslint-plugin-redundant-undefined": "^0.4.0",
 "eslint-plugin-relay": "^1.8.3",
 "flow-api-translator": "0.15.0",
 "flow-bin": "^0.214.0",
 "glob": "^7.1.1",
 "hermes-eslint": "0.15.0",
Expand Down

2 changes: 1 addition & 1 deletion
packages/dev-middleware/src/index.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,4 +17,4 @@ if (!process.env.BUILD_EXCLUDE_BABEL_REGISTER) {
 require('../../../scripts/build/babel-register').registerForMonorepo();
}

module.exports = require('./index.flow');
export * from './index.flow';

44 changes: 44 additions & 0 deletions
scripts/build/babel/node.config.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
/**
 * 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.
 *
 * @flow
 * @format
 * @oncall react_native
 */

/*::
import type {BabelCoreOptions} from '@babel/core';
*/

const TARGET_NODE_VERSION = '18';

const config /*: BabelCoreOptions */ = {
 presets: [
 '@babel/preset-flow',
 [
 '@babel/preset-env',
 {
 targets: {
 node: TARGET_NODE_VERSION,
 },
 },
 ],
 ],
 plugins: [
 [
 'transform-define',
 {
 'process.env.BUILD_EXCLUDE_BABEL_REGISTER': true,
 },
 ],
 [
 'minify-dead-code-elimination',
 {keepFnName: true, keepFnArgs: true, keepClassName: true},
 ],
 ],
};

module.exports = config;

156 changes: 123 additions & 33 deletions
scripts/build/build.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,14 +12,22 @@
const babel = require('@babel/core');
const {parseArgs} = require('@pkgjs/parseargs');
const chalk = require('chalk');
const translate = require('flow-api-translator');
const glob = require('glob');
const micromatch = require('micromatch');
const fs = require('fs');
const {promises: fs} = require('fs');
const path = require('path');
const prettier = require('prettier');
const {buildConfig, getBabelConfig} = require('./config');

const PACKAGES_DIR /*: string */ = path.resolve(__dirname, '../../packages');
const ts = require('typescript');
const {
 buildConfig,
 getBabelConfig,
 getBuildOptions,
 getTypeScriptCompilerOptions,
} = require('./config');

const REPO_ROOT = path.resolve(__dirname, '../..');
const PACKAGES_DIR /*: string */ = path.join(REPO_ROOT, 'packages');
const SRC_DIR = 'src';
const BUILD_DIR = 'dist';
const JS_FILES_PATTERN = '**/*.js';
Expand All@@ -32,7 +40,7 @@ const config = {
 },
};

function build() {
async function build() {
 const {
 positionals: packageNames,
 values: {help},
Expand All@@ -53,35 +61,48 @@ function build() {

 console.log('\n' + chalk.bold.inverse('Building packages') + '\n');

if (packageNames.length) {
 packageNames
 .filter(packageName => packageName in buildConfig.packages)
 .forEach(buildPackage);
} else {
Object.keys(buildConfig.packages).forEach(buildPackage);
const packagesToBuild = packageNames.length
? packageNames.filter(packageName => packageName in buildConfig.packages)
: Object.keys(buildConfig.packages);

for (const packageName of packagesToBuild) {
await buildPackage(packageName);
 }

 process.exitCode = 0;
}

function buildPackage(packageName /*: string */) {
async function buildPackage(packageName /*: string */) {
 const {emitTypeScriptDefs} = getBuildOptions(packageName);
 const files = glob.sync(
 path.resolve(PACKAGES_DIR, packageName, SRC_DIR, '**/*'),
 {nodir: true},
 );
 const packageJsonPath = path.join(PACKAGES_DIR, packageName, 'package.json');

 process.stdout.write(
 `${packageName} ${chalk.dim('.').repeat(72 - packageName.length)} `,
 );
 files.forEach(file => buildFile(path.normalize(file), true));
 rewritePackageExports(packageJsonPath);

 // Build all files matched for package
 for (const file of files) {
 await buildFile(path.normalize(file), true);
 }

 // Validate program for emitted .d.ts files
 if (emitTypeScriptDefs) {
 validateTypeScriptDefs(packageName);
 }

 // Rewrite package.json "exports" field (src -> dist)
 await rewritePackageExports(packageName);

 process.stdout.write(chalk.reset.inverse.bold.green(' DONE ') + '\n');
}

function buildFile(file /*: string */, silent /*: boolean */ = false) {
async function buildFile(file /*: string */, silent /*: boolean */ = false) {
 const packageName = getPackageName(file);
 const buildPath = getBuildPath(file);
 const {emitFlowDefs, emitTypeScriptDefs} = getBuildOptions(packageName);

 const logResult = ({copied, desc} /*: {copied: boolean, desc?: string} */) =>
 silent ||
Expand All@@ -97,24 +118,43 @@ function buildFile(file /*: string */, silent /*: boolean */ = false) {
 return;
 }

 fs.mkdirSync(path.dirname(buildPath), {recursive: true});
await fs.mkdir(path.dirname(buildPath), {recursive: true});

 if (!micromatch.isMatch(file, JS_FILES_PATTERN)) {
 fs.copyFileSync(file, buildPath);
await fs.copyFile(file, buildPath);
 logResult({copied: true, desc: 'copy'});
 } else {
 const transformed = prettier.format(
 babel.transformFileSync(file, getBabelConfig(packageName)).code,
 {parser: 'babel'},
 );
 fs.writeFileSync(buildPath, transformed);
 return;
 }

 if (/@flow/.test(fs.readFileSync(file, 'utf-8'))) {
 fs.copyFileSync(file, buildPath + '.flow');
 }
 const source = await fs.readFile(file, 'utf-8');
 const prettierConfig = {parser: 'babel'};

 logResult({copied: true});
 // Transform source file using Babel
 const transformed = prettier.format(
 (await babel.transformFileAsync(file, getBabelConfig(packageName))).code,
 prettierConfig,
 );
 await fs.writeFile(buildPath, transformed);

 // Translate source Flow types for each type definition target
 if (/@flow/.test(source)) {
 await Promise.all([
 emitFlowDefs
 ? fs.writeFile(
 buildPath + '.flow',
 await translate.translateFlowToFlowDef(source, prettierConfig),
 )
 : null,
 emitTypeScriptDefs
 ? fs.writeFile(
 buildPath.replace(/\.js$/, '') + '.d.ts',
 await translate.translateFlowToTSDef(source, prettierConfig),
 )
 : null,
 ]);
 }

 logResult({copied: true});
}

function getPackageName(file /*: string */) /*: string */ {
Expand All@@ -130,16 +170,22 @@ function getBuildPath(file /*: string */) /*: string */ {
 );
}

function rewritePackageExports(packageJsonPath /*: string */) {
 const pkg = JSON.parse(fs.readFileSync(packageJsonPath, {encoding: 'utf8'}));
async function rewritePackageExports(packageName /*: string */) {
 const packageJsonPath = path.join(PACKAGES_DIR, packageName, 'package.json');
 const pkg = JSON.parse(await fs.readFile(packageJsonPath, 'utf8'));

 if (pkg.exports == null) {
 return;
 throw new Error(
 packageName +
 ' does not define an "exports" field in its package.json. As part ' +
 'of the build setup, this field must be used in order to rewrite ' +
 'paths to built files in production.',
 );
 }

 pkg.exports = rewriteExportsField(pkg.exports);

 fs.writeFileSync(
await fs.writeFile(
 packageJsonPath,
 prettier.format(JSON.stringify(pkg), {parser: 'json'}),
 );
Expand DownExpand Up@@ -173,6 +219,49 @@ function rewriteExportsTarget(target /*: string */) /*: string */ {
 return target.replace('./' + SRC_DIR + '/', './' + BUILD_DIR + '/');
}

function validateTypeScriptDefs(packageName /*: string */) {
 const files = glob.sync(
 path.resolve(PACKAGES_DIR, packageName, BUILD_DIR, '**/*.d.ts'),
 );
 const compilerOptions = {
 ...getTypeScriptCompilerOptions(packageName),
 noEmit: true,
 skipLibCheck: false,
 };
 const program = ts.createProgram(files, compilerOptions);
 const emitResult = program.emit();

 if (emitResult.diagnostics.length) {
 for (const diagnostic of emitResult.diagnostics) {
 if (diagnostic.file != null) {
 let {line, character} = ts.getLineAndCharacterOfPosition(
 diagnostic.file,
 diagnostic.start,
 );
 let message = ts.flattenDiagnosticMessageText(
 diagnostic.messageText,
 '\n',
 );
 console.log(
 // $FlowIssue[incompatible-use] Type refined above
 `${diagnostic.file.fileName} (${line + 1},${
 character + 1
 }): ${message}`,
 );
 } else {
 console.log(
 ts.flattenDiagnosticMessageText(diagnostic.messageText, '\n'),
 );
 }
 }

 throw new Error(
 'Failing build because TypeScript errors were encountered for ' +
 'generated type definitions.',
 );
 }
}

module.exports = {
 buildFile,
 getBuildPath,
Expand All@@ -182,5 +271,6 @@ module.exports = {
};

if (require.main === module) {
 build();
 // eslint-disable-next-line no-void
 void build();
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
Add auto-generation of TypeScript definitions on build#38990

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

huntie
wants to merge
1
commit into

from

 Closed


Add auto-generation of TypeScript definitions on build
#38990
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


13 changes: 13 additions & 0 deletions
flow-typed/npm/@tsconfig/node18_v1.x.x.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
/**
 * 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.
 *
 * @flow
 * @format
 */

declare module '@tsconfig/node18/tsconfig.json' {
 declare module.exports: any;
}

56 changes: 56 additions & 0 deletions
flow-typed/npm/typescript_v5.x.x.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
/**
 * 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.
 *
 * @flow
 * @format
 */

declare module 'typescript' {
 declare enum ModuleResolutionKind {
 Classic = 'Classic',
 NodeJs = 'NodeJs',
 Node10 = 'Node10',
 Node16 = 'Node16',
 NodeNext = 'NodeNext',
 Bundler = 'Bundler',
 }

 declare type SourceFile = $ReadOnly<{
 fileName: string,
 text: string,
 ...
 }>;

 declare type Diagnostic = $ReadOnly<{
 file?: SourceFile,
 start?: number,
 messageText: string,
 ...
 }>;

 declare type EmitResult = $ReadOnly<{
 diagnostics: Array<Diagnostic>,
 ...
 }>;

 declare type Program = $ReadOnly<{
 emit: () => EmitResult,
 ...
 }>;

 declare type TypeScriptAPI = {
 createProgram(files: Array<string>, compilerOptions: Object): Program,
 flattenDiagnosticMessageText: (...messageText: Array<string>) => string,
 getLineAndCharacterOfPosition(
 file: SourceFile,
 start?: number,
 ): $ReadOnly<{line: number, character: number}>,
 ModuleResolutionKind: typeof ModuleResolutionKind,
 ...
 };

 declare module.exports: TypeScriptAPI;
}

2 changes: 2 additions & 0 deletions
package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,6 +57,7 @@
 "@pkgjs/parseargs": "^0.11.0",
 "@react-native/metro-babel-transformer": "^0.73.11",
 "@react-native/metro-config": "^0.73.0",
 "@tsconfig/node18": "1.0.1",
 "@types/react": "^18.0.18",
 "@typescript-eslint/parser": "^5.57.1",
 "async": "^3.2.2",
Expand All@@ -81,6 +82,7 @@
 "eslint-plugin-react-native": "^4.0.0",
 "eslint-plugin-redundant-undefined": "^0.4.0",
 "eslint-plugin-relay": "^1.8.3",
 "flow-api-translator": "0.15.0",
 "flow-bin": "^0.214.0",
 "glob": "^7.1.1",
 "hermes-eslint": "0.15.0",
Expand Down

2 changes: 1 addition & 1 deletion
packages/dev-middleware/src/index.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,4 +17,4 @@ if (!process.env.BUILD_EXCLUDE_BABEL_REGISTER) {
 require('../../../scripts/build/babel-register').registerForMonorepo();
}

module.exports = require('./index.flow');
export * from './index.flow';

44 changes: 44 additions & 0 deletions
scripts/build/babel/node.config.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
/**
 * 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.
 *
 * @flow
 * @format
 * @oncall react_native
 */

/*::
import type {BabelCoreOptions} from '@babel/core';
*/

const TARGET_NODE_VERSION = '18';

const config /*: BabelCoreOptions */ = {
 presets: [
 '@babel/preset-flow',
 [
 '@babel/preset-env',
 {
 targets: {
 node: TARGET_NODE_VERSION,
 },
 },
 ],
 ],
 plugins: [
 [
 'transform-define',
 {
 'process.env.BUILD_EXCLUDE_BABEL_REGISTER': true,
 },
 ],
 [
 'minify-dead-code-elimination',
 {keepFnName: true, keepFnArgs: true, keepClassName: true},
 ],
 ],
};

module.exports = config;

156 changes: 123 additions & 33 deletions
scripts/build/build.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,14 +12,22 @@
const babel = require('@babel/core');
const {parseArgs} = require('@pkgjs/parseargs');
const chalk = require('chalk');
const translate = require('flow-api-translator');
const glob = require('glob');
const micromatch = require('micromatch');
const fs = require('fs');
const {promises: fs} = require('fs');
const path = require('path');
const prettier = require('prettier');
const {buildConfig, getBabelConfig} = require('./config');

const PACKAGES_DIR /*: string */ = path.resolve(__dirname, '../../packages');
const ts = require('typescript');
const {
 buildConfig,
 getBabelConfig,
 getBuildOptions,
 getTypeScriptCompilerOptions,
} = require('./config');

const REPO_ROOT = path.resolve(__dirname, '../..');
const PACKAGES_DIR /*: string */ = path.join(REPO_ROOT, 'packages');
const SRC_DIR = 'src';
const BUILD_DIR = 'dist';
const JS_FILES_PATTERN = '**/*.js';
Expand All@@ -32,7 +40,7 @@ const config = {
 },
};

function build() {
async function build() {
 const {
 positionals: packageNames,
 values: {help},
Expand All@@ -53,35 +61,48 @@ function build() {

 console.log('\n' + chalk.bold.inverse('Building packages') + '\n');

if (packageNames.length) {
 packageNames
 .filter(packageName => packageName in buildConfig.packages)
 .forEach(buildPackage);
} else {
Object.keys(buildConfig.packages).forEach(buildPackage);
const packagesToBuild = packageNames.length
? packageNames.filter(packageName => packageName in buildConfig.packages)
: Object.keys(buildConfig.packages);

for (const packageName of packagesToBuild) {
await buildPackage(packageName);
 }

 process.exitCode = 0;
}

function buildPackage(packageName /*: string */) {
async function buildPackage(packageName /*: string */) {
 const {emitTypeScriptDefs} = getBuildOptions(packageName);
 const files = glob.sync(
 path.resolve(PACKAGES_DIR, packageName, SRC_DIR, '**/*'),
 {nodir: true},
 );
 const packageJsonPath = path.join(PACKAGES_DIR, packageName, 'package.json');

 process.stdout.write(
 `${packageName} ${chalk.dim('.').repeat(72 - packageName.length)} `,
 );
 files.forEach(file => buildFile(path.normalize(file), true));
 rewritePackageExports(packageJsonPath);

 // Build all files matched for package
 for (const file of files) {
 await buildFile(path.normalize(file), true);
 }

 // Validate program for emitted .d.ts files
 if (emitTypeScriptDefs) {
 validateTypeScriptDefs(packageName);
 }

 // Rewrite package.json "exports" field (src -> dist)
 await rewritePackageExports(packageName);

 process.stdout.write(chalk.reset.inverse.bold.green(' DONE ') + '\n');
}

function buildFile(file /*: string */, silent /*: boolean */ = false) {
async function buildFile(file /*: string */, silent /*: boolean */ = false) {
 const packageName = getPackageName(file);
 const buildPath = getBuildPath(file);
 const {emitFlowDefs, emitTypeScriptDefs} = getBuildOptions(packageName);

 const logResult = ({copied, desc} /*: {copied: boolean, desc?: string} */) =>
 silent ||
Expand All@@ -97,24 +118,43 @@ function buildFile(file /*: string */, silent /*: boolean */ = false) {
 return;
 }

 fs.mkdirSync(path.dirname(buildPath), {recursive: true});
await fs.mkdir(path.dirname(buildPath), {recursive: true});

 if (!micromatch.isMatch(file, JS_FILES_PATTERN)) {
 fs.copyFileSync(file, buildPath);
await fs.copyFile(file, buildPath);
 logResult({copied: true, desc: 'copy'});
 } else {
 const transformed = prettier.format(
 babel.transformFileSync(file, getBabelConfig(packageName)).code,
 {parser: 'babel'},
 );
 fs.writeFileSync(buildPath, transformed);
 return;
 }

 if (/@flow/.test(fs.readFileSync(file, 'utf-8'))) {
 fs.copyFileSync(file, buildPath + '.flow');
 }
 const source = await fs.readFile(file, 'utf-8');
 const prettierConfig = {parser: 'babel'};

 logResult({copied: true});
 // Transform source file using Babel
 const transformed = prettier.format(
 (await babel.transformFileAsync(file, getBabelConfig(packageName))).code,
 prettierConfig,
 );
 await fs.writeFile(buildPath, transformed);

 // Translate source Flow types for each type definition target
 if (/@flow/.test(source)) {
 await Promise.all([
 emitFlowDefs
 ? fs.writeFile(
 buildPath + '.flow',
 await translate.translateFlowToFlowDef(source, prettierConfig),
 )
 : null,
 emitTypeScriptDefs
 ? fs.writeFile(
 buildPath.replace(/\.js$/, '') + '.d.ts',
 await translate.translateFlowToTSDef(source, prettierConfig),
 )
 : null,
 ]);
 }

 logResult({copied: true});
}

function getPackageName(file /*: string */) /*: string */ {
Expand All@@ -130,16 +170,22 @@ function getBuildPath(file /*: string */) /*: string */ {
 );
}

function rewritePackageExports(packageJsonPath /*: string */) {
 const pkg = JSON.parse(fs.readFileSync(packageJsonPath, {encoding: 'utf8'}));
async function rewritePackageExports(packageName /*: string */) {
 const packageJsonPath = path.join(PACKAGES_DIR, packageName, 'package.json');
 const pkg = JSON.parse(await fs.readFile(packageJsonPath, 'utf8'));

 if (pkg.exports == null) {
 return;
 throw new Error(
 packageName +
 ' does not define an "exports" field in its package.json. As part ' +
 'of the build setup, this field must be used in order to rewrite ' +
 'paths to built files in production.',
 );
 }

 pkg.exports = rewriteExportsField(pkg.exports);

 fs.writeFileSync(
await fs.writeFile(
 packageJsonPath,
 prettier.format(JSON.stringify(pkg), {parser: 'json'}),
 );
Expand DownExpand Up@@ -173,6 +219,49 @@ function rewriteExportsTarget(target /*: string */) /*: string */ {
 return target.replace('./' + SRC_DIR + '/', './' + BUILD_DIR + '/');
}

function validateTypeScriptDefs(packageName /*: string */) {
 const files = glob.sync(
 path.resolve(PACKAGES_DIR, packageName, BUILD_DIR, '**/*.d.ts'),
 );
 const compilerOptions = {
 ...getTypeScriptCompilerOptions(packageName),
 noEmit: true,
 skipLibCheck: false,
 };
 const program = ts.createProgram(files, compilerOptions);
 const emitResult = program.emit();

 if (emitResult.diagnostics.length) {
 for (const diagnostic of emitResult.diagnostics) {
 if (diagnostic.file != null) {
 let {line, character} = ts.getLineAndCharacterOfPosition(
 diagnostic.file,
 diagnostic.start,
 );
 let message = ts.flattenDiagnosticMessageText(
 diagnostic.messageText,
 '\n',
 );
 console.log(
 // $FlowIssue[incompatible-use] Type refined above
 `${diagnostic.file.fileName} (${line + 1},${
 character + 1
 }): ${message}`,
 );
 } else {
 console.log(
 ts.flattenDiagnosticMessageText(diagnostic.messageText, '\n'),
 );
 }
 }

 throw new Error(
 'Failing build because TypeScript errors were encountered for ' +
 'generated type definitions.',
 );
 }
}

module.exports = {
 buildFile,
 getBuildPath,
Expand All@@ -182,5 +271,6 @@ module.exports = {
};

if (require.main === module) {
 build();
 // eslint-disable-next-line no-void
 void build();
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Add auto-generation of TypeScript definitions on build#38990

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

huntie
wants to merge
1
commit into

from

 Closed


Add auto-generation of TypeScript definitions on build
#38990
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


13 changes: 13 additions & 0 deletions
flow-typed/npm/@tsconfig/node18_v1.x.x.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
/**
 * 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.
 *
 * @flow
 * @format
 */

declare module '@tsconfig/node18/tsconfig.json' {
 declare module.exports: any;
}

56 changes: 56 additions & 0 deletions
flow-typed/npm/typescript_v5.x.x.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
/**
 * 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.
 *
 * @flow
 * @format
 */

declare module 'typescript' {
 declare enum ModuleResolutionKind {
 Classic = 'Classic',
 NodeJs = 'NodeJs',
 Node10 = 'Node10',
 Node16 = 'Node16',
 NodeNext = 'NodeNext',
 Bundler = 'Bundler',
 }

 declare type SourceFile = $ReadOnly<{
 fileName: string,
 text: string,
 ...
 }>;

 declare type Diagnostic = $ReadOnly<{
 file?: SourceFile,
 start?: number,
 messageText: string,
 ...
 }>;

 declare type EmitResult = $ReadOnly<{
 diagnostics: Array<Diagnostic>,
 ...
 }>;

 declare type Program = $ReadOnly<{
 emit: () => EmitResult,
 ...
 }>;

 declare type TypeScriptAPI = {
 createProgram(files: Array<string>, compilerOptions: Object): Program,
 flattenDiagnosticMessageText: (...messageText: Array<string>) => string,
 getLineAndCharacterOfPosition(
 file: SourceFile,
 start?: number,
 ): $ReadOnly<{line: number, character: number}>,
 ModuleResolutionKind: typeof ModuleResolutionKind,
 ...
 };

 declare module.exports: TypeScriptAPI;
}

2 changes: 2 additions & 0 deletions
package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,6 +57,7 @@
 "@pkgjs/parseargs": "^0.11.0",
 "@react-native/metro-babel-transformer": "^0.73.11",
 "@react-native/metro-config": "^0.73.0",
 "@tsconfig/node18": "1.0.1",
 "@types/react": "^18.0.18",
 "@typescript-eslint/parser": "^5.57.1",
 "async": "^3.2.2",
Expand All@@ -81,6 +82,7 @@
 "eslint-plugin-react-native": "^4.0.0",
 "eslint-plugin-redundant-undefined": "^0.4.0",
 "eslint-plugin-relay": "^1.8.3",
 "flow-api-translator": "0.15.0",
 "flow-bin": "^0.214.0",
 "glob": "^7.1.1",
 "hermes-eslint": "0.15.0",
Expand Down

2 changes: 1 addition & 1 deletion
packages/dev-middleware/src/index.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,4 +17,4 @@ if (!process.env.BUILD_EXCLUDE_BABEL_REGISTER) {
 require('../../../scripts/build/babel-register').registerForMonorepo();
}

module.exports = require('./index.flow');
export * from './index.flow';

44 changes: 44 additions & 0 deletions
scripts/build/babel/node.config.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
/**
 * 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.
 *
 * @flow
 * @format
 * @oncall react_native
 */

/*::
import type {BabelCoreOptions} from '@babel/core';
*/

const TARGET_NODE_VERSION = '18';

const config /*: BabelCoreOptions */ = {
 presets: [
 '@babel/preset-flow',
 [
 '@babel/preset-env',
 {
 targets: {
 node: TARGET_NODE_VERSION,
 },
 },
 ],
 ],
 plugins: [
 [
 'transform-define',
 {
 'process.env.BUILD_EXCLUDE_BABEL_REGISTER': true,
 },
 ],
 [
 'minify-dead-code-elimination',
 {keepFnName: true, keepFnArgs: true, keepClassName: true},
 ],
 ],
};

module.exports = config;

156 changes: 123 additions & 33 deletions
scripts/build/build.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,14 +12,22 @@
const babel = require('@babel/core');
const {parseArgs} = require('@pkgjs/parseargs');
const chalk = require('chalk');
const translate = require('flow-api-translator');
const glob = require('glob');
const micromatch = require('micromatch');
const fs = require('fs');
const {promises: fs} = require('fs');
const path = require('path');
const prettier = require('prettier');
const {buildConfig, getBabelConfig} = require('./config');

const PACKAGES_DIR /*: string */ = path.resolve(__dirname, '../../packages');
const ts = require('typescript');
const {
 buildConfig,
 getBabelConfig,
 getBuildOptions,
 getTypeScriptCompilerOptions,
} = require('./config');

const REPO_ROOT = path.resolve(__dirname, '../..');
const PACKAGES_DIR /*: string */ = path.join(REPO_ROOT, 'packages');
const SRC_DIR = 'src';
const BUILD_DIR = 'dist';
const JS_FILES_PATTERN = '**/*.js';
Expand All@@ -32,7 +40,7 @@ const config = {
 },
};

function build() {
async function build() {
 const {
 positionals: packageNames,
 values: {help},
Expand All@@ -53,35 +61,48 @@ function build() {

 console.log('\n' + chalk.bold.inverse('Building packages') + '\n');

if (packageNames.length) {
 packageNames
 .filter(packageName => packageName in buildConfig.packages)
 .forEach(buildPackage);
} else {
Object.keys(buildConfig.packages).forEach(buildPackage);
const packagesToBuild = packageNames.length
? packageNames.filter(packageName => packageName in buildConfig.packages)
: Object.keys(buildConfig.packages);

for (const packageName of packagesToBuild) {
await buildPackage(packageName);
 }

 process.exitCode = 0;
}

function buildPackage(packageName /*: string */) {
async function buildPackage(packageName /*: string */) {
 const {emitTypeScriptDefs} = getBuildOptions(packageName);
 const files = glob.sync(
 path.resolve(PACKAGES_DIR, packageName, SRC_DIR, '**/*'),
 {nodir: true},
 );
 const packageJsonPath = path.join(PACKAGES_DIR, packageName, 'package.json');

 process.stdout.write(
 `${packageName} ${chalk.dim('.').repeat(72 - packageName.length)} `,
 );
 files.forEach(file => buildFile(path.normalize(file), true));
 rewritePackageExports(packageJsonPath);

 // Build all files matched for package
 for (const file of files) {
 await buildFile(path.normalize(file), true);
 }

 // Validate program for emitted .d.ts files
 if (emitTypeScriptDefs) {
 validateTypeScriptDefs(packageName);
 }

 // Rewrite package.json "exports" field (src -> dist)
 await rewritePackageExports(packageName);

 process.stdout.write(chalk.reset.inverse.bold.green(' DONE ') + '\n');
}

function buildFile(file /*: string */, silent /*: boolean */ = false) {
async function buildFile(file /*: string */, silent /*: boolean */ = false) {
 const packageName = getPackageName(file);
 const buildPath = getBuildPath(file);
 const {emitFlowDefs, emitTypeScriptDefs} = getBuildOptions(packageName);

 const logResult = ({copied, desc} /*: {copied: boolean, desc?: string} */) =>
 silent ||
Expand All@@ -97,24 +118,43 @@ function buildFile(file /*: string */, silent /*: boolean */ = false) {
 return;
 }

 fs.mkdirSync(path.dirname(buildPath), {recursive: true});
await fs.mkdir(path.dirname(buildPath), {recursive: true});

 if (!micromatch.isMatch(file, JS_FILES_PATTERN)) {
 fs.copyFileSync(file, buildPath);
await fs.copyFile(file, buildPath);
 logResult({copied: true, desc: 'copy'});
 } else {
 const transformed = prettier.format(
 babel.transformFileSync(file, getBabelConfig(packageName)).code,
 {parser: 'babel'},
 );
 fs.writeFileSync(buildPath, transformed);
 return;
 }

 if (/@flow/.test(fs.readFileSync(file, 'utf-8'))) {
 fs.copyFileSync(file, buildPath + '.flow');
 }
 const source = await fs.readFile(file, 'utf-8');
 const prettierConfig = {parser: 'babel'};

 logResult({copied: true});
 // Transform source file using Babel
 const transformed = prettier.format(
 (await babel.transformFileAsync(file, getBabelConfig(packageName))).code,
 prettierConfig,
 );
 await fs.writeFile(buildPath, transformed);

 // Translate source Flow types for each type definition target
 if (/@flow/.test(source)) {
 await Promise.all([
 emitFlowDefs
 ? fs.writeFile(
 buildPath + '.flow',
 await translate.translateFlowToFlowDef(source, prettierConfig),
 )
 : null,
 emitTypeScriptDefs
 ? fs.writeFile(
 buildPath.replace(/\.js$/, '') + '.d.ts',
 await translate.translateFlowToTSDef(source, prettierConfig),
 )
 : null,
 ]);
 }

 logResult({copied: true});
}

function getPackageName(file /*: string */) /*: string */ {
Expand All@@ -130,16 +170,22 @@ function getBuildPath(file /*: string */) /*: string */ {
 );
}

function rewritePackageExports(packageJsonPath /*: string */) {
 const pkg = JSON.parse(fs.readFileSync(packageJsonPath, {encoding: 'utf8'}));
async function rewritePackageExports(packageName /*: string */) {
 const packageJsonPath = path.join(PACKAGES_DIR, packageName, 'package.json');
 const pkg = JSON.parse(await fs.readFile(packageJsonPath, 'utf8'));

 if (pkg.exports == null) {
 return;
 throw new Error(
 packageName +
 ' does not define an "exports" field in its package.json. As part ' +
 'of the build setup, this field must be used in order to rewrite ' +
 'paths to built files in production.',
 );
 }

 pkg.exports = rewriteExportsField(pkg.exports);

 fs.writeFileSync(
await fs.writeFile(
 packageJsonPath,
 prettier.format(JSON.stringify(pkg), {parser: 'json'}),
 );
Expand DownExpand Up@@ -173,6 +219,49 @@ function rewriteExportsTarget(target /*: string */) /*: string */ {
 return target.replace('./' + SRC_DIR + '/', './' + BUILD_DIR + '/');
}

function validateTypeScriptDefs(packageName /*: string */) {
 const files = glob.sync(
 path.resolve(PACKAGES_DIR, packageName, BUILD_DIR, '**/*.d.ts'),
 );
 const compilerOptions = {
 ...getTypeScriptCompilerOptions(packageName),
 noEmit: true,
 skipLibCheck: false,
 };
 const program = ts.createProgram(files, compilerOptions);
 const emitResult = program.emit();

 if (emitResult.diagnostics.length) {
 for (const diagnostic of emitResult.diagnostics) {
 if (diagnostic.file != null) {
 let {line, character} = ts.getLineAndCharacterOfPosition(
 diagnostic.file,
 diagnostic.start,
 );
 let message = ts.flattenDiagnosticMessageText(
 diagnostic.messageText,
 '\n',
 );
 console.log(
 // $FlowIssue[incompatible-use] Type refined above
 `${diagnostic.file.fileName} (${line + 1},${
 character + 1
 }): ${message}`,
 );
 } else {
 console.log(
 ts.flattenDiagnosticMessageText(diagnostic.messageText, '\n'),
 );
 }
 }

 throw new Error(
 'Failing build because TypeScript errors were encountered for ' +
 'generated type definitions.',
 );
 }
}

module.exports = {
 buildFile,
 getBuildPath,
Expand All@@ -182,5 +271,6 @@ module.exports = {
};

if (require.main === module) {
 build();
 // eslint-disable-next-line no-void
 void build();
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Add auto-generation of TypeScript definitions on build#38990

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

huntie
wants to merge
1
commit into

from

 Closed


Add auto-generation of TypeScript definitions on build
#38990
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


13 changes: 13 additions & 0 deletions
flow-typed/npm/@tsconfig/node18_v1.x.x.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
/**
 * 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.
 *
 * @flow
 * @format
 */

declare module '@tsconfig/node18/tsconfig.json' {
 declare module.exports: any;
}

56 changes: 56 additions & 0 deletions
flow-typed/npm/typescript_v5.x.x.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
/**
 * 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.
 *
 * @flow
 * @format
 */

declare module 'typescript' {
 declare enum ModuleResolutionKind {
 Classic = 'Classic',
 NodeJs = 'NodeJs',
 Node10 = 'Node10',
 Node16 = 'Node16',
 NodeNext = 'NodeNext',
 Bundler = 'Bundler',
 }

 declare type SourceFile = $ReadOnly<{
 fileName: string,
 text: string,
 ...
 }>;

 declare type Diagnostic = $ReadOnly<{
 file?: SourceFile,
 start?: number,
 messageText: string,
 ...
 }>;

 declare type EmitResult = $ReadOnly<{
 diagnostics: Array<Diagnostic>,
 ...
 }>;

 declare type Program = $ReadOnly<{
 emit: () => EmitResult,
 ...
 }>;

 declare type TypeScriptAPI = {
 createProgram(files: Array<string>, compilerOptions: Object): Program,
 flattenDiagnosticMessageText: (...messageText: Array<string>) => string,
 getLineAndCharacterOfPosition(
 file: SourceFile,
 start?: number,
 ): $ReadOnly<{line: number, character: number}>,
 ModuleResolutionKind: typeof ModuleResolutionKind,
 ...
 };

 declare module.exports: TypeScriptAPI;
}

2 changes: 2 additions & 0 deletions
package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,6 +57,7 @@
 "@pkgjs/parseargs": "^0.11.0",
 "@react-native/metro-babel-transformer": "^0.73.11",
 "@react-native/metro-config": "^0.73.0",
 "@tsconfig/node18": "1.0.1",
 "@types/react": "^18.0.18",
 "@typescript-eslint/parser": "^5.57.1",
 "async": "^3.2.2",
Expand All@@ -81,6 +82,7 @@
 "eslint-plugin-react-native": "^4.0.0",
 "eslint-plugin-redundant-undefined": "^0.4.0",
 "eslint-plugin-relay": "^1.8.3",
 "flow-api-translator": "0.15.0",
 "flow-bin": "^0.214.0",
 "glob": "^7.1.1",
 "hermes-eslint": "0.15.0",
Expand Down

2 changes: 1 addition & 1 deletion
packages/dev-middleware/src/index.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,4 +17,4 @@ if (!process.env.BUILD_EXCLUDE_BABEL_REGISTER) {
 require('../../../scripts/build/babel-register').registerForMonorepo();
}

module.exports = require('./index.flow');
export * from './index.flow';

44 changes: 44 additions & 0 deletions
scripts/build/babel/node.config.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
/**
 * 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.
 *
 * @flow
 * @format
 * @oncall react_native
 */

/*::
import type {BabelCoreOptions} from '@babel/core';
*/

const TARGET_NODE_VERSION = '18';

const config /*: BabelCoreOptions */ = {
 presets: [
 '@babel/preset-flow',
 [
 '@babel/preset-env',
 {
 targets: {
 node: TARGET_NODE_VERSION,
 },
 },
 ],
 ],
 plugins: [
 [
 'transform-define',
 {
 'process.env.BUILD_EXCLUDE_BABEL_REGISTER': true,
 },
 ],
 [
 'minify-dead-code-elimination',
 {keepFnName: true, keepFnArgs: true, keepClassName: true},
 ],
 ],
};

module.exports = config;

156 changes: 123 additions & 33 deletions
scripts/build/build.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,14 +12,22 @@
const babel = require('@babel/core');
const {parseArgs} = require('@pkgjs/parseargs');
const chalk = require('chalk');
const translate = require('flow-api-translator');
const glob = require('glob');
const micromatch = require('micromatch');
const fs = require('fs');
const {promises: fs} = require('fs');
const path = require('path');
const prettier = require('prettier');
const {buildConfig, getBabelConfig} = require('./config');

const PACKAGES_DIR /*: string */ = path.resolve(__dirname, '../../packages');
const ts = require('typescript');
const {
 buildConfig,
 getBabelConfig,
 getBuildOptions,
 getTypeScriptCompilerOptions,
} = require('./config');

const REPO_ROOT = path.resolve(__dirname, '../..');
const PACKAGES_DIR /*: string */ = path.join(REPO_ROOT, 'packages');
const SRC_DIR = 'src';
const BUILD_DIR = 'dist';
const JS_FILES_PATTERN = '**/*.js';
Expand All@@ -32,7 +40,7 @@ const config = {
 },
};

function build() {
async function build() {
 const {
 positionals: packageNames,
 values: {help},
Expand All@@ -53,35 +61,48 @@ function build() {

 console.log('\n' + chalk.bold.inverse('Building packages') + '\n');

if (packageNames.length) {
 packageNames
 .filter(packageName => packageName in buildConfig.packages)
 .forEach(buildPackage);
} else {
Object.keys(buildConfig.packages).forEach(buildPackage);
const packagesToBuild = packageNames.length
? packageNames.filter(packageName => packageName in buildConfig.packages)
: Object.keys(buildConfig.packages);

for (const packageName of packagesToBuild) {
await buildPackage(packageName);
 }

 process.exitCode = 0;
}

function buildPackage(packageName /*: string */) {
async function buildPackage(packageName /*: string */) {
 const {emitTypeScriptDefs} = getBuildOptions(packageName);
 const files = glob.sync(
 path.resolve(PACKAGES_DIR, packageName, SRC_DIR, '**/*'),
 {nodir: true},
 );
 const packageJsonPath = path.join(PACKAGES_DIR, packageName, 'package.json');

 process.stdout.write(
 `${packageName} ${chalk.dim('.').repeat(72 - packageName.length)} `,
 );
 files.forEach(file => buildFile(path.normalize(file), true));
 rewritePackageExports(packageJsonPath);

 // Build all files matched for package
 for (const file of files) {
 await buildFile(path.normalize(file), true);
 }

 // Validate program for emitted .d.ts files
 if (emitTypeScriptDefs) {
 validateTypeScriptDefs(packageName);
 }

 // Rewrite package.json "exports" field (src -> dist)
 await rewritePackageExports(packageName);

 process.stdout.write(chalk.reset.inverse.bold.green(' DONE ') + '\n');
}

function buildFile(file /*: string */, silent /*: boolean */ = false) {
async function buildFile(file /*: string */, silent /*: boolean */ = false) {
 const packageName = getPackageName(file);
 const buildPath = getBuildPath(file);
 const {emitFlowDefs, emitTypeScriptDefs} = getBuildOptions(packageName);

 const logResult = ({copied, desc} /*: {copied: boolean, desc?: string} */) =>
 silent ||
Expand All@@ -97,24 +118,43 @@ function buildFile(file /*: string */, silent /*: boolean */ = false) {
 return;
 }

 fs.mkdirSync(path.dirname(buildPath), {recursive: true});
await fs.mkdir(path.dirname(buildPath), {recursive: true});

 if (!micromatch.isMatch(file, JS_FILES_PATTERN)) {
 fs.copyFileSync(file, buildPath);
await fs.copyFile(file, buildPath);
 logResult({copied: true, desc: 'copy'});
 } else {
 const transformed = prettier.format(
 babel.transformFileSync(file, getBabelConfig(packageName)).code,
 {parser: 'babel'},
 );
 fs.writeFileSync(buildPath, transformed);
 return;
 }

 if (/@flow/.test(fs.readFileSync(file, 'utf-8'))) {
 fs.copyFileSync(file, buildPath + '.flow');
 }
 const source = await fs.readFile(file, 'utf-8');
 const prettierConfig = {parser: 'babel'};

 logResult({copied: true});
 // Transform source file using Babel
 const transformed = prettier.format(
 (await babel.transformFileAsync(file, getBabelConfig(packageName))).code,
 prettierConfig,
 );
 await fs.writeFile(buildPath, transformed);

 // Translate source Flow types for each type definition target
 if (/@flow/.test(source)) {
 await Promise.all([
 emitFlowDefs
 ? fs.writeFile(
 buildPath + '.flow',
 await translate.translateFlowToFlowDef(source, prettierConfig),
 )
 : null,
 emitTypeScriptDefs
 ? fs.writeFile(
 buildPath.replace(/\.js$/, '') + '.d.ts',
 await translate.translateFlowToTSDef(source, prettierConfig),
 )
 : null,
 ]);
 }

 logResult({copied: true});
}

function getPackageName(file /*: string */) /*: string */ {
Expand All@@ -130,16 +170,22 @@ function getBuildPath(file /*: string */) /*: string */ {
 );
}

function rewritePackageExports(packageJsonPath /*: string */) {
 const pkg = JSON.parse(fs.readFileSync(packageJsonPath, {encoding: 'utf8'}));
async function rewritePackageExports(packageName /*: string */) {
 const packageJsonPath = path.join(PACKAGES_DIR, packageName, 'package.json');
 const pkg = JSON.parse(await fs.readFile(packageJsonPath, 'utf8'));

 if (pkg.exports == null) {
 return;
 throw new Error(
 packageName +
 ' does not define an "exports" field in its package.json. As part ' +
 'of the build setup, this field must be used in order to rewrite ' +
 'paths to built files in production.',
 );
 }

 pkg.exports = rewriteExportsField(pkg.exports);

 fs.writeFileSync(
await fs.writeFile(
 packageJsonPath,
 prettier.format(JSON.stringify(pkg), {parser: 'json'}),
 );
Expand DownExpand Up@@ -173,6 +219,49 @@ function rewriteExportsTarget(target /*: string */) /*: string */ {
 return target.replace('./' + SRC_DIR + '/', './' + BUILD_DIR + '/');
}

function validateTypeScriptDefs(packageName /*: string */) {
 const files = glob.sync(
 path.resolve(PACKAGES_DIR, packageName, BUILD_DIR, '**/*.d.ts'),
 );
 const compilerOptions = {
 ...getTypeScriptCompilerOptions(packageName),
 noEmit: true,
 skipLibCheck: false,
 };
 const program = ts.createProgram(files, compilerOptions);
 const emitResult = program.emit();

 if (emitResult.diagnostics.length) {
 for (const diagnostic of emitResult.diagnostics) {
 if (diagnostic.file != null) {
 let {line, character} = ts.getLineAndCharacterOfPosition(
 diagnostic.file,
 diagnostic.start,
 );
 let message = ts.flattenDiagnosticMessageText(
 diagnostic.messageText,
 '\n',
 );
 console.log(
 // $FlowIssue[incompatible-use] Type refined above
 `${diagnostic.file.fileName} (${line + 1},${
 character + 1
 }): ${message}`,
 );
 } else {
 console.log(
 ts.flattenDiagnosticMessageText(diagnostic.messageText, '\n'),
 );
 }
 }

 throw new Error(
 'Failing build because TypeScript errors were encountered for ' +
 'generated type definitions.',
 );
 }
}

module.exports = {
 buildFile,
 getBuildPath,
Expand All@@ -182,5 +271,6 @@ module.exports = {
};

if (require.main === module) {
 build();
 // eslint-disable-next-line no-void
 void build();
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
Add auto-generation of TypeScript definitions on build#38990

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

huntie
wants to merge
1
commit into

from

 Closed


Add auto-generation of TypeScript definitions on build
#38990
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


13 changes: 13 additions & 0 deletions
flow-typed/npm/@tsconfig/node18_v1.x.x.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
/**
 * 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.
 *
 * @flow
 * @format
 */

declare module '@tsconfig/node18/tsconfig.json' {
 declare module.exports: any;
}

56 changes: 56 additions & 0 deletions
flow-typed/npm/typescript_v5.x.x.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
/**
 * 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.
 *
 * @flow
 * @format
 */

declare module 'typescript' {
 declare enum ModuleResolutionKind {
 Classic = 'Classic',
 NodeJs = 'NodeJs',
 Node10 = 'Node10',
 Node16 = 'Node16',
 NodeNext = 'NodeNext',
 Bundler = 'Bundler',
 }

 declare type SourceFile = $ReadOnly<{
 fileName: string,
 text: string,
 ...
 }>;

 declare type Diagnostic = $ReadOnly<{
 file?: SourceFile,
 start?: number,
 messageText: string,
 ...
 }>;

 declare type EmitResult = $ReadOnly<{
 diagnostics: Array<Diagnostic>,
 ...
 }>;

 declare type Program = $ReadOnly<{
 emit: () => EmitResult,
 ...
 }>;

 declare type TypeScriptAPI = {
 createProgram(files: Array<string>, compilerOptions: Object): Program,
 flattenDiagnosticMessageText: (...messageText: Array<string>) => string,
 getLineAndCharacterOfPosition(
 file: SourceFile,
 start?: number,
 ): $ReadOnly<{line: number, character: number}>,
 ModuleResolutionKind: typeof ModuleResolutionKind,
 ...
 };

 declare module.exports: TypeScriptAPI;
}

2 changes: 2 additions & 0 deletions
package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,6 +57,7 @@
 "@pkgjs/parseargs": "^0.11.0",
 "@react-native/metro-babel-transformer": "^0.73.11",
 "@react-native/metro-config": "^0.73.0",
 "@tsconfig/node18": "1.0.1",
 "@types/react": "^18.0.18",
 "@typescript-eslint/parser": "^5.57.1",
 "async": "^3.2.2",
Expand All@@ -81,6 +82,7 @@
 "eslint-plugin-react-native": "^4.0.0",
 "eslint-plugin-redundant-undefined": "^0.4.0",
 "eslint-plugin-relay": "^1.8.3",
 "flow-api-translator": "0.15.0",
 "flow-bin": "^0.214.0",
 "glob": "^7.1.1",
 "hermes-eslint": "0.15.0",
Expand Down

2 changes: 1 addition & 1 deletion
packages/dev-middleware/src/index.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,4 +17,4 @@ if (!process.env.BUILD_EXCLUDE_BABEL_REGISTER) {
 require('../../../scripts/build/babel-register').registerForMonorepo();
}

module.exports = require('./index.flow');
export * from './index.flow';

44 changes: 44 additions & 0 deletions
scripts/build/babel/node.config.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
/**
 * 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.
 *
 * @flow
 * @format
 * @oncall react_native
 */

/*::
import type {BabelCoreOptions} from '@babel/core';
*/

const TARGET_NODE_VERSION = '18';

const config /*: BabelCoreOptions */ = {
 presets: [
 '@babel/preset-flow',
 [
 '@babel/preset-env',
 {
 targets: {
 node: TARGET_NODE_VERSION,
 },
 },
 ],
 ],
 plugins: [
 [
 'transform-define',
 {
 'process.env.BUILD_EXCLUDE_BABEL_REGISTER': true,
 },
 ],
 [
 'minify-dead-code-elimination',
 {keepFnName: true, keepFnArgs: true, keepClassName: true},
 ],
 ],
};

module.exports = config;

156 changes: 123 additions & 33 deletions
scripts/build/build.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,14 +12,22 @@
const babel = require('@babel/core');
const {parseArgs} = require('@pkgjs/parseargs');
const chalk = require('chalk');
const translate = require('flow-api-translator');
const glob = require('glob');
const micromatch = require('micromatch');
const fs = require('fs');
const {promises: fs} = require('fs');
const path = require('path');
const prettier = require('prettier');
const {buildConfig, getBabelConfig} = require('./config');

const PACKAGES_DIR /*: string */ = path.resolve(__dirname, '../../packages');
const ts = require('typescript');
const {
 buildConfig,
 getBabelConfig,
 getBuildOptions,
 getTypeScriptCompilerOptions,
} = require('./config');

const REPO_ROOT = path.resolve(__dirname, '../..');
const PACKAGES_DIR /*: string */ = path.join(REPO_ROOT, 'packages');
const SRC_DIR = 'src';
const BUILD_DIR = 'dist';
const JS_FILES_PATTERN = '**/*.js';
Expand All@@ -32,7 +40,7 @@ const config = {
 },
};

function build() {
async function build() {
 const {
 positionals: packageNames,
 values: {help},
Expand All@@ -53,35 +61,48 @@ function build() {

 console.log('\n' + chalk.bold.inverse('Building packages') + '\n');

if (packageNames.length) {
 packageNames
 .filter(packageName => packageName in buildConfig.packages)
 .forEach(buildPackage);
} else {
Object.keys(buildConfig.packages).forEach(buildPackage);
const packagesToBuild = packageNames.length
? packageNames.filter(packageName => packageName in buildConfig.packages)
: Object.keys(buildConfig.packages);

for (const packageName of packagesToBuild) {
await buildPackage(packageName);
 }

 process.exitCode = 0;
}

function buildPackage(packageName /*: string */) {
async function buildPackage(packageName /*: string */) {
 const {emitTypeScriptDefs} = getBuildOptions(packageName);
 const files = glob.sync(
 path.resolve(PACKAGES_DIR, packageName, SRC_DIR, '**/*'),
 {nodir: true},
 );
 const packageJsonPath = path.join(PACKAGES_DIR, packageName, 'package.json');

 process.stdout.write(
 `${packageName} ${chalk.dim('.').repeat(72 - packageName.length)} `,
 );
 files.forEach(file => buildFile(path.normalize(file), true));
 rewritePackageExports(packageJsonPath);

 // Build all files matched for package
 for (const file of files) {
 await buildFile(path.normalize(file), true);
 }

 // Validate program for emitted .d.ts files
 if (emitTypeScriptDefs) {
 validateTypeScriptDefs(packageName);
 }

 // Rewrite package.json "exports" field (src -> dist)
 await rewritePackageExports(packageName);

 process.stdout.write(chalk.reset.inverse.bold.green(' DONE ') + '\n');
}

function buildFile(file /*: string */, silent /*: boolean */ = false) {
async function buildFile(file /*: string */, silent /*: boolean */ = false) {
 const packageName = getPackageName(file);
 const buildPath = getBuildPath(file);
 const {emitFlowDefs, emitTypeScriptDefs} = getBuildOptions(packageName);

 const logResult = ({copied, desc} /*: {copied: boolean, desc?: string} */) =>
 silent ||
Expand All@@ -97,24 +118,43 @@ function buildFile(file /*: string */, silent /*: boolean */ = false) {
 return;
 }

 fs.mkdirSync(path.dirname(buildPath), {recursive: true});
await fs.mkdir(path.dirname(buildPath), {recursive: true});

 if (!micromatch.isMatch(file, JS_FILES_PATTERN)) {
 fs.copyFileSync(file, buildPath);
await fs.copyFile(file, buildPath);
 logResult({copied: true, desc: 'copy'});
 } else {
 const transformed = prettier.format(
 babel.transformFileSync(file, getBabelConfig(packageName)).code,
 {parser: 'babel'},
 );
 fs.writeFileSync(buildPath, transformed);
 return;
 }

 if (/@flow/.test(fs.readFileSync(file, 'utf-8'))) {
 fs.copyFileSync(file, buildPath + '.flow');
 }
 const source = await fs.readFile(file, 'utf-8');
 const prettierConfig = {parser: 'babel'};

 logResult({copied: true});
 // Transform source file using Babel
 const transformed = prettier.format(
 (await babel.transformFileAsync(file, getBabelConfig(packageName))).code,
 prettierConfig,
 );
 await fs.writeFile(buildPath, transformed);

 // Translate source Flow types for each type definition target
 if (/@flow/.test(source)) {
 await Promise.all([
 emitFlowDefs
 ? fs.writeFile(
 buildPath + '.flow',
 await translate.translateFlowToFlowDef(source, prettierConfig),
 )
 : null,
 emitTypeScriptDefs
 ? fs.writeFile(
 buildPath.replace(/\.js$/, '') + '.d.ts',
 await translate.translateFlowToTSDef(source, prettierConfig),
 )
 : null,
 ]);
 }

 logResult({copied: true});
}

function getPackageName(file /*: string */) /*: string */ {
Expand All@@ -130,16 +170,22 @@ function getBuildPath(file /*: string */) /*: string */ {
 );
}

function rewritePackageExports(packageJsonPath /*: string */) {
 const pkg = JSON.parse(fs.readFileSync(packageJsonPath, {encoding: 'utf8'}));
async function rewritePackageExports(packageName /*: string */) {
 const packageJsonPath = path.join(PACKAGES_DIR, packageName, 'package.json');
 const pkg = JSON.parse(await fs.readFile(packageJsonPath, 'utf8'));

 if (pkg.exports == null) {
 return;
 throw new Error(
 packageName +
 ' does not define an "exports" field in its package.json. As part ' +
 'of the build setup, this field must be used in order to rewrite ' +
 'paths to built files in production.',
 );
 }

 pkg.exports = rewriteExportsField(pkg.exports);

 fs.writeFileSync(
await fs.writeFile(
 packageJsonPath,
 prettier.format(JSON.stringify(pkg), {parser: 'json'}),
 );
Expand DownExpand Up@@ -173,6 +219,49 @@ function rewriteExportsTarget(target /*: string */) /*: string */ {
 return target.replace('./' + SRC_DIR + '/', './' + BUILD_DIR + '/');
}

function validateTypeScriptDefs(packageName /*: string */) {
 const files = glob.sync(
 path.resolve(PACKAGES_DIR, packageName, BUILD_DIR, '**/*.d.ts'),
 );
 const compilerOptions = {
 ...getTypeScriptCompilerOptions(packageName),
 noEmit: true,
 skipLibCheck: false,
 };
 const program = ts.createProgram(files, compilerOptions);
 const emitResult = program.emit();

 if (emitResult.diagnostics.length) {
 for (const diagnostic of emitResult.diagnostics) {
 if (diagnostic.file != null) {
 let {line, character} = ts.getLineAndCharacterOfPosition(
 diagnostic.file,
 diagnostic.start,
 );
 let message = ts.flattenDiagnosticMessageText(
 diagnostic.messageText,
 '\n',
 );
 console.log(
 // $FlowIssue[incompatible-use] Type refined above
 `${diagnostic.file.fileName} (${line + 1},${
 character + 1
 }): ${message}`,
 );
 } else {
 console.log(
 ts.flattenDiagnosticMessageText(diagnostic.messageText, '\n'),
 );
 }
 }

 throw new Error(
 'Failing build because TypeScript errors were encountered for ' +
 'generated type definitions.',
 );
 }
}

module.exports = {
 buildFile,
 getBuildPath,
Expand All@@ -182,5 +271,6 @@ module.exports = {
};

if (require.main === module) {
 build();
 // eslint-disable-next-line no-void
 void build();
}
Loading