yeoman-generator.test.ts

/******************************************************************************
 * Copyright 2022 TypeFox GmbH
 * This program and the accompanying materials are made available under the
 * terms of the MIT License, which is available in the project root.
 ******************************************************************************/

import { describe, test } from 'vitest';
import { normalizeEOL } from 'langium';
import { createHelpers } from 'yeoman-test';
import * as path from 'node:path';
import * as url from 'node:url';

const __dirname = url.fileURLToPath(new URL('../', import.meta.url));

const answersForCore = {
    extensionName: 'hello-world',
    rawLanguageName: 'Hello World',
    fileExtension: '.hello',
    includeVSCode: false,
    includeCLI: false,
    includeWeb: false,
    openWith: false
};

describe('Check yeoman generator works', () => {
    const moduleRoot = path.join(__dirname, 'app');

    test('Should produce files for Core', async () => {

        const context = createHelpers({}).run(moduleRoot);
        context.targetDirectory =  path.join(__dirname, '../../../examples/hello-world'); // generate in examples
        const targetRoot = path.join(__dirname, '../../../examples');
        context.cleanTestDirectory(true); // clean-up examples/hello-world
        await context
            .onGenerator(async (generator) => {
                // will generate into examples/hello-world instead of examples/hello-world/hello-world
                generator.destinationRoot(targetRoot); // types are wrong, should be string
            })
            .withAnswers(answersForCore)
            .withArguments('skip-install')
            .then((result) => {
                const files = [
                    targetRoot + '/hello-world/.eslintrc.json',
                    targetRoot + '/hello-world/.gitignore',
                    targetRoot + '/hello-world/langium-config.json',
                    targetRoot + '/hello-world/langium-quickstart.md',
                    targetRoot + '/hello-world/tsconfig.json',
                    targetRoot + '/hello-world/package.json',
                    targetRoot + '/hello-world/.vscode/extensions.json',
                    targetRoot + '/hello-world/.vscode/tasks.json',
                    targetRoot + '/hello-world/src/language/hello-world-module.ts',
                    targetRoot + '/hello-world/src/language/hello-world-validator.ts',
                    targetRoot + '/hello-world/src/language/hello-world.langium'
                ];
                result.assertFile(files);
                result.assertJsonFileContent(targetRoot + '/hello-world/package.json', PACKAGE_JSON_EXPECTATION);
                result.assertFileContent(targetRoot + '/hello-world/.vscode/tasks.json', TASKS_JSON_EXPECTATION);
            }).finally(() => {
                context.cleanTestDirectory(true);
            });
    }, 120_000);

});

// eslint-disable-next-line @typescript-eslint/no-var-requires
const langiumVersion = `~${require('../../langium/package.json').version}`;
// eslint-disable-next-line @typescript-eslint/no-var-requires
const langiumCliVersion = `~${require('../../langium-cli/package.json').version}`;

// eslint-disable-next-line @typescript-eslint/no-explicit-any
const PACKAGE_JSON_EXPECTATION: Record<string, any> = {
    name: 'hello-world',
    description: 'Please enter a brief description here',
    version: '0.0.1',
    files: ['out', 'src'],
    scripts: {
        'build': 'tsc -b tsconfig.json',
        'watch': 'tsc -b tsconfig.json --watch',
        'lint': 'eslint src --ext ts',
        'langium:generate': 'langium generate',
        'langium:watch': 'langium generate --watch'
    },
    'dependencies': {
        'langium': langiumVersion
    },
    'devDependencies': {
        '@types/node': '~16.18.41',
        '@typescript-eslint/eslint-plugin': '~6.4.1',
        '@typescript-eslint/parser': '~6.4.1',
        'eslint': '~8.47.0',
        'langium-cli': langiumCliVersion,
        'typescript': '~5.1.6'
    }
};

const TASKS_JSON_EXPECTATION =
normalizeEOL(`{
    // See https://go.microsoft.com/fwlink/?LinkId=733558
    // for the documentation about the tasks.json format
    "version": "2.0.0",
    "tasks": [
        {
            "label": "Build hello-world",
            "command": "npm run langium:generate && npm run build",
            "type": "shell",
            "group": {
                "kind": "build",
                "isDefault": true
            },
            "detail": "Langium: Generate grammar and build the hello-world language",
            "icon": {
                "color": "terminal.ansiGreen",
                "id": "server-process"
            }
        }
    ]
}
`);