Basically working Yeoman template generator generator

This commit is contained in:
SteveSandersonMS
2016-04-28 17:01:27 +01:00
parent fc705e8bf8
commit 4de2e9673f
12 changed files with 281 additions and 52 deletions

View File

@@ -5,7 +5,7 @@
"main": "index.js", "main": "index.js",
"scripts": { "scripts": {
"test": "echo \"Error: no test specified\" && exit 1", "test": "echo \"Error: no test specified\" && exit 1",
"build": "tsc && node ./built/CreateGenerator.js" "build": "tsc && node ./tmp/build/build.js"
}, },
"author": "Microsoft", "author": "Microsoft",
"license": "Apache-2.0", "license": "Apache-2.0",

View File

@@ -1,48 +0,0 @@
import * as glob from 'glob';
import * as gitignore from 'gitignore-parser';
import * as fs from 'fs';
import * as path from 'path';
import * as _ from 'lodash';
import * as mkdirp from 'mkdirp';
import * as rimraf from 'rimraf';
const textFileExtensions = ['.gitignore', '.config', '.cs', '.cshtml', 'Dockerfile', '.html', '.js', '.json', '.jsx', '.md', '.ts', '.tsx'];
const templates = {
'angular-2': '../../templates/Angular2Spa/',
'knockout': '../../templates/KnockoutSpa/',
'react-redux': '../../templates/ReactReduxSpa/',
'react': '../../templates/ReactSpa/'
};
function isTextFile(filename: string): boolean {
return textFileExtensions.indexOf(path.extname(filename).toLowerCase()) >= 0;
}
function writeFileEnsuringDirExists(root: string, filename: string, contents: string | Buffer) {
let fullPath = path.join(root, filename);
mkdirp.sync(path.dirname(fullPath));
fs.writeFileSync(fullPath, contents);
}
function listFilesExcludingGitignored(root: string): string[] {
let gitignoreEvaluator = gitignore.compile(fs.readFileSync(path.join(root, '.gitignore'), 'utf8'));
return glob.sync('**/*', { cwd: root, dot: true, nodir: true })
.filter(fn => gitignoreEvaluator.accepts(fn));
}
function writeTemplate(sourceRoot: string, destRoot: string) {
listFilesExcludingGitignored(sourceRoot).forEach(fn => {
const sourceContent = fs.readFileSync(path.join(sourceRoot, fn));
writeFileEnsuringDirExists(destRoot, fn, sourceContent);
});
}
const outputRoot = './generator-aspnet-spa';
const commonRoot = path.join(outputRoot, 'templates/common');
rimraf.sync(outputRoot);
_.forEach(templates, (templateRootDir, templateName) => {
const outputDir = path.join(outputRoot, 'templates', templateName);
writeTemplate(templateRootDir, outputDir);
});

View File

@@ -0,0 +1,96 @@
import * as glob from 'glob';
import * as gitignore from 'gitignore-parser';
import * as fs from 'fs';
import * as path from 'path';
import * as _ from 'lodash';
import * as mkdirp from 'mkdirp';
import * as rimraf from 'rimraf';
const textFileExtensions = ['.gitignore', '.config', '.cs', '.cshtml', 'Dockerfile', '.html', '.js', '.json', '.jsx', '.md', '.ts', '.tsx', '.xproj'];
const templates = {
'angular-2': '../../templates/Angular2Spa/',
'knockout': '../../templates/KnockoutSpa/',
'react-redux': '../../templates/ReactReduxSpa/',
'react': '../../templates/ReactSpa/'
};
const contentReplacements: { from: RegExp, to: string }[] = [
{ from: /\bWebApplicationBasic\b/g, to: '<%= namePascalCase %>' },
{ from: /<ProjectGuid>[0-9a-f\-]{36}<\/ProjectGuid>/g, to: '<ProjectGuid><%= projectGuid %></ProjectGuid>' },
{ from: /<RootNamespace>.*?<\/RootNamespace>/g, to: '<RootNamespace><%= namePascalCase %></RootNamespace>'},
{ from: /\s*<BaseIntermediateOutputPath.*?<\/BaseIntermediateOutputPath>/g, to: '' },
{ from: /\s*<OutputPath.*?<\/OutputPath>/g, to: '' },
];
const filenameReplacements: { from: RegExp, to: string }[] = [
{ from: /.*\.xproj$/, to: 'tokenreplace-namePascalCase.xproj' }
];
function isTextFile(filename: string): boolean {
return textFileExtensions.indexOf(path.extname(filename).toLowerCase()) >= 0;
}
function writeFileEnsuringDirExists(root: string, filename: string, contents: string | Buffer) {
let fullPath = path.join(root, filename);
mkdirp.sync(path.dirname(fullPath));
fs.writeFileSync(fullPath, contents);
}
function listFilesExcludingGitignored(root: string): string[] {
let gitIgnorePath = path.join(root, '.gitignore');
let gitignoreEvaluator = fs.existsSync(gitIgnorePath)
? gitignore.compile(fs.readFileSync(gitIgnorePath, 'utf8'))
: { accepts: () => true };
return glob.sync('**/*', { cwd: root, dot: true, nodir: true })
.filter(fn => gitignoreEvaluator.accepts(fn));
}
function writeTemplate(sourceRoot: string, destRoot: string) {
listFilesExcludingGitignored(sourceRoot).forEach(fn => {
let sourceContent = fs.readFileSync(path.join(sourceRoot, fn));
// For text files, replace hardcoded values with template tags
if (isTextFile(fn)) {
let sourceText = sourceContent.toString('utf8');
contentReplacements.forEach(replacement => {
sourceText = sourceText.replace(replacement.from, replacement.to);
});
sourceContent = new Buffer(sourceText, 'utf8');
}
// Also apply replacements in filenames
filenameReplacements.forEach(replacement => {
fn = fn.replace(replacement.from, replacement.to);
});
writeFileEnsuringDirExists(destRoot, fn, sourceContent);
});
}
function copyRecursive(sourceRoot: string, destRoot: string, matchGlob: string) {
glob.sync(matchGlob, { cwd: sourceRoot, dot: true, nodir: true })
.forEach(fn => {
const sourceContent = fs.readFileSync(path.join(sourceRoot, fn));
writeFileEnsuringDirExists(destRoot, fn, sourceContent);
});
}
const outputRoot = './generator-aspnet-spa';
const outputTemplatesRoot = path.join(outputRoot, 'app/templates');
rimraf.sync(outputTemplatesRoot);
// Copy template files
_.forEach(templates, (templateRootDir, templateName) => {
const outputDir = path.join(outputTemplatesRoot, templateName);
writeTemplate(templateRootDir, outputDir);
});
// Also copy the generator files (that's the compiled .js files, plus all other non-.ts files)
const tempRoot = './tmp';
copyRecursive(path.join(tempRoot, 'generator'), outputRoot, '**/*.js');
copyRecursive('./src/generator', outputRoot, '**/!(*.ts)');
// Clean up
rimraf.sync(tempRoot);

View File

@@ -0,0 +1,58 @@
import * as path from 'path';
import * as yeoman from 'yeoman-generator';
import * as uuid from 'node-uuid';
import * as glob from 'glob';
const toPascalCase = require('to-pascal-case');
const templates = [
{ value: 'angular-2', name: 'Angular 2' },
{ value: 'knockout', name: 'Knockout' },
{ value: 'react', name: 'React' },
{ value: 'react-redux', name: 'React with Redux' }
];
class MyGenerator extends yeoman.Base {
private _answers: any;
constructor(args: string | string[], options: any) {
super(args, options);
}
prompting() {
const done = this.async();
this.prompt([{
type: 'list',
name: 'framework',
message: 'Framework',
choices: templates
}, {
type: 'input',
name: 'name',
message: 'Your project name',
default: this.appname
}], answers => {
this._answers = answers;
this._answers.namePascalCase = toPascalCase(answers.name);
this._answers.projectGuid = uuid.v4();
done();
})
}
writing() {
var templateRoot = this.templatePath(this._answers.framework);
glob.sync('**/*', { cwd: templateRoot, dot: true, nodir: true }).forEach(fn => {
// Token replacement in filenames
let outputFn = fn.replace(/tokenreplace\-([^\.\/]*)/g, (substr, token) => this._answers[token]);
this.fs.copyTpl(
path.join(templateRoot, fn),
this.destinationPath(outputFn),
this._answers
);
});
}
}
declare var module: any;
(module).exports = MyGenerator;

View File

@@ -0,0 +1,10 @@
{
"name": "generator-aspnet-spa",
"version": "0.1.0",
"description": "Single-Page App templates for ASP.NET Core",
"files": ["templates"],
"keywords": ["yeoman-generator"],
"dependencies": {
"yeoman-generator": "^0.20.2"
}
}

View File

@@ -2,7 +2,7 @@
"compilerOptions": { "compilerOptions": {
"moduleResolution": "node", "moduleResolution": "node",
"target": "es5", "target": "es5",
"outDir": "built", "outDir": "tmp",
"sourceMap": false "sourceMap": false
}, },
"exclude": [ "exclude": [

View File

@@ -9,7 +9,7 @@
"commit": "544a35a10866b32afda9c7f029c0764558563f4f" "commit": "544a35a10866b32afda9c7f029c0764558563f4f"
}, },
"node/node.d.ts": { "node/node.d.ts": {
"commit": "544a35a10866b32afda9c7f029c0764558563f4f" "commit": "08ed4e9f1869e37e29514d862e0158b40e550232"
}, },
"glob/glob.d.ts": { "glob/glob.d.ts": {
"commit": "544a35a10866b32afda9c7f029c0764558563f4f" "commit": "544a35a10866b32afda9c7f029c0764558563f4f"
@@ -25,6 +25,15 @@
}, },
"rimraf/rimraf.d.ts": { "rimraf/rimraf.d.ts": {
"commit": "544a35a10866b32afda9c7f029c0764558563f4f" "commit": "544a35a10866b32afda9c7f029c0764558563f4f"
},
"node-uuid/node-uuid.d.ts": {
"commit": "08ed4e9f1869e37e29514d862e0158b40e550232"
},
"node-uuid/node-uuid-base.d.ts": {
"commit": "08ed4e9f1869e37e29514d862e0158b40e550232"
},
"node-uuid/node-uuid-cjs.d.ts": {
"commit": "08ed4e9f1869e37e29514d862e0158b40e550232"
} }
} }
} }

View File

@@ -0,0 +1,46 @@
// Type definitions for node-uuid.js
// Project: https://github.com/broofa/node-uuid
// Definitions by: Jeff May <https://github.com/jeffmay>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
/** Common definitions for all environments */
declare namespace __NodeUUID {
interface UUIDOptions {
/**
* Node id as Array of 6 bytes (per 4.1.6).
* Default: Randomly generated ID. See note 1.
*/
node?: any[];
/**
* (Number between 0 - 0x3fff) RFC clock sequence.
* Default: An internally maintained clockseq is used.
*/
clockseq?: number;
/**
* (Number | Date) Time in milliseconds since unix Epoch.
* Default: The current time is used.
*/
msecs?: number|Date;
/**
* (Number between 0-9999) additional time, in 100-nanosecond units. Ignored if msecs is unspecified.
* Default: internal uuid counter is used, as per 4.2.1.2.
*/
nsecs?: number;
}
interface UUID {
v1(options?: UUIDOptions): string;
v1(options?: UUIDOptions, buffer?: number[], offset?: number): number[];
v4(options?: UUIDOptions): string;
v4(options?: UUIDOptions, buffer?: number[], offset?: number): number[];
parse(id: string, buffer?: number[], offset?: number): number[];
unparse(buffer: number[], offset?: number): string;
}
}

View File

@@ -0,0 +1,15 @@
// Type definitions for node-uuid.js
// Project: https://github.com/broofa/node-uuid
// Definitions by: Jeff May <https://github.com/jeffmay>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
/// <reference path="./node-uuid-base.d.ts" />
/**
* Expose as CommonJS module
* For use in node environment or browser environment (using webpack or other module loaders)
*/
declare module "node-uuid" {
var uuid: __NodeUUID.UUID;
export = uuid;
}

View File

@@ -0,0 +1,36 @@
// Type definitions for node-uuid.js
// Project: https://github.com/broofa/node-uuid
// Definitions by: Jeff May <https://github.com/jeffmay>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
/// <reference path="../node/node.d.ts" />
/// <reference path="./node-uuid-base.d.ts" />
/// <reference path="./node-uuid-cjs.d.ts" />
/**
* Definitions for use in node environment
*
* !! For browser enviroments, use node-uuid-global or node-uuid-cjs
*/
declare module __NodeUUID {
/**
* Overloads for node environment
* We need to duplicate some declarations because
* interface merging doesn't work with overloads
*/
interface UUID {
v1(options?: UUIDOptions): string;
v1(options?: UUIDOptions, buffer?: number[], offset?: number): number[];
v1(options?: UUIDOptions, buffer?: Buffer, offset?: number): Buffer;
v4(options?: UUIDOptions): string;
v4(options?: UUIDOptions, buffer?: number[], offset?: number): number[];
v4(options?: UUIDOptions, buffer?: Buffer, offset?: number): Buffer;
parse(id: string, buffer?: number[], offset?: number): number[];
parse(id: string, buffer?: Buffer, offset?: number): Buffer;
unparse(buffer: number[], offset?: number): string;
unparse(buffer: Buffer, offset?: number): string;
}
}

View File

@@ -679,6 +679,8 @@ declare module "cluster" {
kill(signal?: string): void; kill(signal?: string): void;
destroy(signal?: string): void; destroy(signal?: string): void;
disconnect(): void; disconnect(): void;
isConnected(): boolean;
isDead(): boolean;
} }
export var settings: ClusterSettings; export var settings: ClusterSettings;
@@ -688,7 +690,9 @@ declare module "cluster" {
export function fork(env?: any): Worker; export function fork(env?: any): Worker;
export function disconnect(callback?: Function): void; export function disconnect(callback?: Function): void;
export var worker: Worker; export var worker: Worker;
export var workers: Worker[]; export var workers: {
[index: string]: Worker
};
// Event emitter // Event emitter
export function addListener(event: string, listener: Function): void; export function addListener(event: string, listener: Function): void;

View File

@@ -5,3 +5,6 @@
/// <reference path="lodash/lodash.d.ts" /> /// <reference path="lodash/lodash.d.ts" />
/// <reference path="mkdirp/mkdirp.d.ts" /> /// <reference path="mkdirp/mkdirp.d.ts" />
/// <reference path="rimraf/rimraf.d.ts" /> /// <reference path="rimraf/rimraf.d.ts" />
/// <reference path="node-uuid/node-uuid-base.d.ts" />
/// <reference path="node-uuid/node-uuid-cjs.d.ts" />
/// <reference path="node-uuid/node-uuid.d.ts" />