Skip to content
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

Fix CLI API import #1160

Merged
merged 1 commit into from
Aug 22, 2023
Merged

Fix CLI API import #1160

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
82 changes: 79 additions & 3 deletions packages/langium-cli/src/generate.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,10 @@
* terms of the MIT License, which is available in the project root.
******************************************************************************/

import type { AstNode, Grammar, LangiumDocument, Mutable} from 'langium';
import type { AstNode, Grammar, LangiumDocument, Mutable } from 'langium';
import type { LangiumConfig, LangiumLanguageConfig} from './package.js';
import { URI } from 'langium';
import type { LangiumConfig, LangiumLanguageConfig } from './package.js';
import { loadConfig } from './package.js';
import { copyAstNode, createLangiumGrammarServices, getDocument, GrammarAST, linkContentToContainer } from 'langium';
import { resolveImport, resolveTransitiveImports } from 'langium/internal';
import { NodeFileSystem } from 'langium/node';
Expand All @@ -16,15 +17,90 @@ import { generateModule } from './generator/module-generator.js';
import { generateTextMate } from './generator/highlighting/textmate-generator.js';
import { generateMonarch } from './generator/highlighting/monarch-generator.js';
import { generatePrismHighlighting } from './generator/highlighting/prism-generator.js';
import { getUserChoice, log } from './generator/util.js';
import { elapsedTime, getTime, getUserChoice, log, schema } from './generator/util.js';
import { getFilePath, RelativePath } from './package.js';
import { validateParser } from './parser-validation.js';
import { generateTypesFile } from './generator/types-generator.js';
import { createGrammarDiagramHtml } from 'langium-railroad';
import { validate } from 'jsonschema';
import chalk from 'chalk';
import * as path from 'path';
import fs from 'fs-extra';

export async function generate(options: GenerateOptions): Promise<boolean> {
const config = await loadConfig(options);
const validation = validate(config, await schema, {
nestedErrors: true
});
if (!validation.valid) {
log('error', options, chalk.red('Error: Your Langium configuration is invalid.'));
const errors = validation.errors.filter(error => error.path.length > 0);
errors.forEach(error => {
log('error', options, `--> ${error.stack}`);
});
return false;
}
const result = await runGenerator(config, options);
if (options.watch) {
printSuccess(result);
console.log(getTime() + 'Langium generator will continue running in watch mode.');
await runWatcher(config, options, await allGeneratorFiles(result));
} else {
console.log(`Langium generator finished ${chalk.green.bold('successfully')} in ${elapsedTime()}ms`);
}
return result.success;
}

async function allGeneratorFiles(results: GeneratorResult): Promise<string[]> {
const files = Array.from(new Set(results.files));
const filesExist = await Promise.all(files.map(e => fs.exists(e)));
return files.filter((_, i) => filesExist[i]);
}

async function runWatcher(config: LangiumConfig, options: GenerateOptions, files: string[]): Promise<void> {
if (files.length === 0) {
return;
}
const watchers: fs.FSWatcher[] = [];
for (const grammarFile of files) {
const watcher = fs.watch(grammarFile, undefined, watch);
watchers.push(watcher);
}
// The watch might be triggered multiple times
// We only want to execute once
let watcherTriggered = false;

async function watch(): Promise<void> {
if (watcherTriggered) {
return;
}
watcherTriggered = true;
// Delay the generation a bit in case multiple files are changed at once
await delay(20);
console.log(getTime() + 'File change detected. Starting compilation...');
const results = await runGenerator(config, options);
for (const watcher of watchers) {
watcher.close();
}
printSuccess(results);
runWatcher(config, options, await allGeneratorFiles(results));
}

await new Promise(() => { /* Never resolve */ });
}

function printSuccess(results: GeneratorResult): void {
if (results.success) {
console.log(`${getTime()}Langium generator finished ${chalk.green.bold('successfully')} in ${elapsedTime()}ms`);
}
}

async function delay(ms: number): Promise<void> {
return new Promise(resolve => {
setTimeout(() => resolve(), ms);
});
}

export interface GenerateOptions {
file?: string;
mode?: 'development' | 'production';
Expand Down
2 changes: 1 addition & 1 deletion packages/langium-cli/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@
******************************************************************************/

export type { GenerateOptions } from './generate.js';
export { generate } from './langium.js';
export { generate } from './generate.js';
85 changes: 3 additions & 82 deletions packages/langium-cli/src/langium.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,10 @@
* terms of the MIT License, which is available in the project root.
******************************************************************************/

import type { ExtractTypesOptions, GenerateOptions, GeneratorResult } from './generate.js';
import type { LangiumConfig } from './package.js';
import chalk from 'chalk';
import fs from 'fs-extra';
import { Command, Option } from 'commander';
import { validate } from 'jsonschema';
import { runGenerator, generateTypes } from './generate.js';
import { cliVersion, elapsedTime, getTime, log, schema } from './generator/util.js';
import { loadConfig } from './package.js';
import type { ExtractTypesOptions, GenerateOptions} from './generate.js';
import { generate, generateTypes } from './generate.js';
import { cliVersion } from './generator/util.js';

const program = new Command();

Expand Down Expand Up @@ -43,77 +38,3 @@ program.command('extract-types')
});

program.parse(process.argv);

export async function generate(options: GenerateOptions): Promise<boolean> {
const config = await loadConfig(options);
const validation = validate(config, await schema, {
nestedErrors: true
});
if (!validation.valid) {
log('error', options, chalk.red('Error: Your Langium configuration is invalid.'));
const errors = validation.errors.filter(error => error.path.length > 0);
errors.forEach(error => {
log('error', options, `--> ${error.stack}`);
});
return false;
}
const result = await runGenerator(config, options);
if (options.watch) {
printSuccess(result);
console.log(getTime() + 'Langium generator will continue running in watch mode.');
await runWatcher(config, options, await allGeneratorFiles(result));
} else {
console.log(`Langium generator finished ${chalk.green.bold('successfully')} in ${elapsedTime()}ms`);
}
return result.success;
}

async function allGeneratorFiles(results: GeneratorResult): Promise<string[]> {
const files = Array.from(new Set(results.files));
const filesExist = await Promise.all(files.map(e => fs.exists(e)));
return files.filter((_, i) => filesExist[i]);
}

async function runWatcher(config: LangiumConfig, options: GenerateOptions, files: string[]): Promise<void> {
if (files.length === 0) {
return;
}
const watchers: fs.FSWatcher[] = [];
for (const grammarFile of files) {
const watcher = fs.watch(grammarFile, undefined, watch);
watchers.push(watcher);
}
// The watch might be triggered multiple times
// We only want to execute once
let watcherTriggered = false;

async function watch(): Promise<void> {
if (watcherTriggered) {
return;
}
watcherTriggered = true;
// Delay the generation a bit in case multiple files are changed at once
await delay(20);
console.log(getTime() + 'File change detected. Starting compilation...');
const results = await runGenerator(config, options);
for (const watcher of watchers) {
watcher.close();
}
printSuccess(results);
runWatcher(config, options, await allGeneratorFiles(results));
}

await new Promise(() => { /* Never resolve */ });
}

function printSuccess(results: GeneratorResult): void {
if (results.success) {
console.log(`${getTime()}Langium generator finished ${chalk.green.bold('successfully')} in ${elapsedTime()}ms`);
}
}

async function delay(ms: number): Promise<void> {
return new Promise(resolve => {
setTimeout(() => resolve(), ms);
});
}