Add an option to generate a minimal project with Yeoman (#1967)

The `.js` extension is no longer imposed when generating a file. Now, the `destination` parameter is required and indicates where to generate the file, and with what extension. The `filePath` parameter is renamed as `source` to better fit the new behaviour and make the code more readable. --------- Co-authored-by: NicolasChusseau <nicolas.chusseau@etu.univ-nantes.fr>

Author: JMazat

packages/generator-langium/src/index.ts

@@ -17,7 +17,11 @@ const __dirname = url.fileURLToPath(new URL('.', import.meta.url));
 
 const BASE_DIR = '../templates';
 const PACKAGE_LANGUAGE = 'packages/language';
+const PACKAGE_LANGUAGE_EXAMPLE = 'packages/language-example';
+const PACKAGE_LANGUAGE_MINIMAL = 'packages/language-minimal';
 const PACKAGE_CLI = 'packages/cli';
+const PACKAGE_CLI_EXAMPLE = 'packages/cli-example';
+const PACKAGE_CLI_MINIMAL = 'packages/cli-minimal';
 const PACKAGE_EXTENSION = 'packages/extension';
 const USER_DIR = '.';
 
@@ -30,6 +34,8 @@ const LANGUAGE_NAME = /<%= LanguageName %>/g;
 const LANGUAGE_ID = /<%= language-id %>/g;
 const LANGUAGE_PATH_ID = /language-id/g;
 
+const ENTRY_NAME = /<%= EntryName %>/g;
+
 const NEWLINES = /\r?\n/g;
 
 export interface Answers {
@@ -38,7 +44,9 @@ export interface Answers {
  fileExtensions: string;
  includeVSCode: boolean;
  includeCLI: boolean;
+ includeExampleProject: boolean;
  includeTest: boolean;
+ entryName: string;
 }
 
 export interface PostAnwers {
@@ -89,7 +97,7 @@ export class LangiumGenerator extends Generator {
  name: 'extensionName',
  prefix: description(
  'Welcome to Langium!',
- 'This tool generates a VS Code extension with a "Hello World" language to get started quickly.',
+ 'This tool generates one or more npm packages to create your own language based on Langium.',
  'The extension name is an identifier used in the extension marketplace or package registry.'
  ),
  message: 'Your extension name:',
@@ -124,6 +132,15 @@ export class LangiumGenerator extends Generator {
  ? true
  : 'A file extension can start with . and must contain only letters and digits. Extensions must be separated by commas.',
  } as PromptQuestion<Answers>,
+ {
+ type: 'input',
+ name: 'entryName',
+ prefix: description(
+ 'The name of the entry rule in your grammar file.'
+ ),
+ message: 'Your grammar entry rule name:',
+ default: 'Model',
+ } as PromptQuestion<Answers>,
  {
  type: 'confirm',
  name: 'includeVSCode',
@@ -133,6 +150,16 @@ export class LangiumGenerator extends Generator {
  message: 'Include VSCode extension?',
  default: true
  } as PromptQuestion<Answers>,
+ {
+ type: 'confirm',
+ name: 'includeExampleProject',
+ prefix: description(
+ 'You can generate an example project to play around with Langium (with a "Hello world" grammar, generator and validator).',
+ 'If not, a minimal project will be generated.'
+ ),
+ message: 'Generate example project?',
+ default: true
+ } as PromptQuestion<Answers>,
  {
  type: 'confirm',
  name: 'includeCLI',
@@ -149,8 +176,8 @@ export class LangiumGenerator extends Generator {
  'You can add the setup for language tests using Vitest.'
  ),
  message: 'Include language tests?',
- default: true
- } as PromptQuestion<Answers>
+ default: true,
+ } as PromptQuestion<Answers>,
  ]);
  }
 
@@ -201,7 +228,8 @@ export class LangiumGenerator extends Generator {
  // .gitignore files don't get published to npm, so we need to copy it under a different name
  this.fs.copy(this.templatePath('gitignore.txt'), this._extensionPath('.gitignore'));
 
- this.sourceRoot(path.join(__dirname, `${BASE_DIR}/${PACKAGE_LANGUAGE}`));
+ this.sourceRoot(path.join(__dirname, `${BASE_DIR}/${this.answers.includeExampleProject ? PACKAGE_LANGUAGE_EXAMPLE : PACKAGE_LANGUAGE_MINIMAL}`));
+
  const languageFiles = [
  'package.json',
  'README.md',
@@ -241,6 +269,9 @@ export * from './generated/ast.js';
 export * from './generated/grammar.js';
 export * from './generated/module.js';
 `;
+ // Write language index.ts and langium-config.json
+ this.fs.write(this._extensionPath('packages/language/src/index.ts'), languageIndex);
+ this.fs.writeJSON(this._extensionPath('packages/language/langium-config.json'), langiumConfigJson, undefined, 4);
 
  if (this.answers.includeTest) {
  mainPackageJson.scripts.test = 'npm run --workspace packages/language test';
@@ -261,7 +292,9 @@ export * from './generated/module.js';
  }
 
  if (this.answers.includeCLI) {
- this.sourceRoot(path.join(__dirname, `${BASE_DIR}/${PACKAGE_CLI}`));
+ this.sourceRoot(path.join(__dirname, `${BASE_DIR}/${
+ this.answers.includeExampleProject ? PACKAGE_CLI_EXAMPLE : PACKAGE_CLI_MINIMAL
+ }`));
  const cliFiles = [
  'package.json',
  'tsconfig.json',
@@ -280,10 +313,6 @@ export * from './generated/module.js';
  tsConfigBuildJson.references.push({ path: './packages/cli/tsconfig.json' });
  }
 
- // Write language index.ts and langium-config.json
- this.fs.write(this._extensionPath('packages/language/src/index.ts'), languageIndex);
- this.fs.writeJSON(this._extensionPath('packages/language/langium-config.json'), langiumConfigJson, undefined, 4);
-
  if (this.answers.includeVSCode) {
  this.sourceRoot(path.join(__dirname, `${BASE_DIR}/${PACKAGE_EXTENSION}`));
  const extensionFiles = [
@@ -363,6 +392,7 @@ export * from './generated/module.js';
  .replace(FILE_EXTENSION_GLOB, fileExtensionGlob)
  .replace(LANGUAGE_NAME, languageName)
  .replace(LANGUAGE_ID, languageId)
+ .replace(ENTRY_NAME, this.answers.entryName)
  .replace(NEWLINES, EOL);
  }
 

packages/generator-langium/templates/packages/cli/README.md renamed to packages/generator-langium/templates/packages/cli-example/README.md

@@ -1,10 +1,10 @@
-import type { Model } from '<%= language-id %>-language';
+import type { <%= EntryName %> } from '<%= language-id %>-language';
 import { expandToNode, joinToNode, toString } from 'langium/generate';
 import * as fs from 'node:fs';
 import * as path from 'node:path';
 import { extractDestinationAndName } from './util.js';
 
-export function generateJavaScript(model: Model, filePath: string, destination: string | undefined): string {
+export function generateJavaScript(model: <%= EntryName %>, filePath: string, destination: string | undefined): string {
  const data = extractDestinationAndName(filePath, destination);
  const generatedFilePath = `${path.join(data.destination, data.name)}.js`;
 

packages/generator-langium/templates/packages/cli/bin/cli.js renamed to packages/generator-langium/templates/packages/cli-example/bin/cli.js

@@ -1,4 +1,4 @@
-import type { Model } from '<%= language-id %>-language';
+import type { <%= EntryName %> } from '<%= language-id %>-language';
 import { create<%= LanguageName %>Services, <%= LanguageName %>LanguageMetaData } from '<%= language-id %>-language';
 import chalk from 'chalk';
 import { Command } from 'commander';
@@ -15,7 +15,7 @@ const packageContent = await fs.readFile(packagePath, 'utf-8');
 
 export const generateAction = async (fileName: string, opts: GenerateOptions): Promise<void> => {
  const services = create<%= LanguageName %>Services(NodeFileSystem).<%= LanguageName %>;
- const model = await extractAstNode<Model>(fileName, services);
+ const model = await extractAstNode<<%= EntryName %>>(fileName, services);
  const generatedFilePath = generateJavaScript(model, fileName, opts.destination);
  console.log(chalk.green(`JavaScript code generated successfully: ${generatedFilePath}`));
 };

packages/generator-langium/templates/packages/cli/package.json renamed to packages/generator-langium/templates/packages/cli-example/package.json

@@ -0,0 +1,17 @@
+# Command-line interface (CLI)
+
+Check [this part](https://langium.org/docs/learn/minilogo/customizing_cli/) of the Langium Minilogo Tutorial as a useful guide to the CLI.
+
+## What's in the folder?
+
+- [package.json](./package.json) - The manifest file of your cli package.
+- [tsconfig.src.json](./tsconfig.src.json) - The package specific TypeScript compiler configuration extending the [base config](../../tsconfig.json).
+- [tsconfig.json](./tsconfig.json) - TypeScript compiler configuration options required for proper functionality of VSCode.
+- [bin/cli.js](bin/cli/cli.js) - Script referenced in the [package.json](./package.json) and used to execute the command-line interface.
+- [src/cli/main.ts](src/cli/main.ts) - The entry point of the command line interface (CLI) of your language.
+- [src/cli/generator.ts](src/cli/generator.ts) - The code generator used by the CLI to write output files from DSL documents.
+- [src/cli/util.ts](src/cli/util.ts) - Utility code for the CLI.
+
+## Instructions
+
+Run `node ./bin/cli` to see options for the CLI; `node ./bin/cli generate <file>` generates code for a given DSL file.

packages/generator-langium/templates/packages/cli/src/generator.ts renamed to packages/generator-langium/templates/packages/cli-example/src/generator.ts

@@ -0,0 +1,4 @@
+#!/usr/bin/env node
+
+import main from '../out/main.js';
+main();