Skip to content

use handlebars for code generation #2228

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

Merged
jacogr merged 12 commits into from
May 4, 2020
Merged

use handlebars for code generation #2228

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
43b988c
use handlebars for code generation
xlc May 3, 2020
40f0ed3
update docs
xlc May 3, 2020
f1e3067
fix isStrict
xlc May 3, 2020
736d0b3
fix lint
xlc May 3, 2020
2fcc258
Apply suggestions from code review
xlc May 4, 2020
7f1a85f
convert consts
xlc May 4, 2020
bdddc23
keep empty lines in doc comments
xlc May 4, 2020
d257af3
update rpc
xlc May 4, 2020
c08270a
update tx
xlc May 4, 2020
9ecd139
update interfaceRegistry
xlc May 4, 2020
2ffde49
update tsDef
xlc May 4, 2020
caa5425
remove no longer used code
xlc May 4, 2020
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
Prev Previous commit
remove no longer used code
  • Loading branch information
@xlc
xlc committed May 4, 2020
commit caa5425ee9e80d6fcd4e8b72d8d8ffe1810d2c29
19 changes: 0 additions & 19 deletions packages/typegen/src/util/docs.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,27 +4,8 @@

import Handlebars from 'handlebars';

import { Text } from '@polkadot/types';

import { indent } from './formatting';
import { readTemplate } from './file';

type AnyString = Text | string;
type Arg = [AnyString, AnyString];

Handlebars.registerPartial({
docs: Handlebars.compile(readTemplate('docs'))
});

export function createDocComments (spaces: number, docs: AnyString[], args: Arg[] = []): string {
const contents = [
...docs.map((doc): string => doc.toString().trim()).filter((doc): boolean => !!doc),
...args.map(([name, type]): string => `@param ${name} ${type}`)
].map((d): string => ` * ${d}`);

return contents.length
? ['/**', ...contents, ' **/\n']
.map((s): string => indent(spaces)(s))
.join('\n')
: '';
}
11 changes: 0 additions & 11 deletions packages/typegen/src/util/formatting.spec.ts
View file
Open in desktop

This file was deleted.

53 changes: 0 additions & 53 deletions packages/typegen/src/util/formatting.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ import { readTemplate } from './file';
const TYPES_NON_PRIMITIVE = ['Metadata'];

export const HEADER = (type: 'chain' | 'defs'): string => `// Auto-generated via \`yarn polkadot-types-from-${type}\`, do not edit\n/* eslint-disable */\n\n`;
export const FOOTER = '\n';

Handlebars.registerPartial({
footer: Handlebars.compile(readTemplate('footer')),
Expand Down Expand Up @@ -72,48 +71,6 @@ Handlebars.registerHelper({
}
});

// creates the import lines
/** @internal */
export function createImportCode (header: string, imports: TypeImports, checks: { file: string; types: string[] }[]): string {
return [
{
file: '@polkadot/types/types',
types: Object.keys(imports.typesTypes)
},
{
file: '@polkadot/types/codec',
types: Object
.keys(imports.codecTypes)
.filter((name): boolean => name !== 'Tuple')
},
{
file: '@polkadot/types/extrinsic',
types: Object.keys(imports.extrinsicTypes)
},
{
file: '@polkadot/types/generic',
types: Object.keys(imports.genericTypes)
},
{
file: '@polkadot/types/primitive',
types: Object
.keys(imports.primitiveTypes)
.filter((name): boolean => !TYPES_NON_PRIMITIVE.includes(name))
},
{
file: '@polkadot/types',
types: Object
.keys(imports.primitiveTypes)
.filter((name): boolean => TYPES_NON_PRIMITIVE.includes(name))
},
...checks
].reduce((result, { file, types }): string => {
return types.length
? `${result}import { ${types.sort().join(', ')} } from '${file}';\n`
: result;
}, header) + '\n';
}

// helper to generate a `export interface <Name> extends <Base> {<Body>}
/** @internal */
export function exportInterface (name = '', base: string, body = ''): string {
Expand Down Expand Up @@ -331,13 +288,3 @@ export function formatType (definitions: object, type: string | TypeDef, imports
}
}
}

/**
* Indent a string with `n` spaces before.
*/
/** @internal */
export function indent (n: number, char = ' '): (str: string) => string {
return function (str: string): string {
return `${char.repeat(n)}${str}`;
};
}