[Experimental] First attempt at replacing AST traversal with Maybe<T> #180
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,162 +1,155 @@ | ||
| import * as ts from 'typescript'; | ||
| import {FileResolver} from './fileResolver/fileResolver'; | ||
| import {AbstractResolver, MetadataUrls} from './urlResolvers/abstractResolver'; | ||
| import {UrlResolver} from './urlResolvers/urlResolver'; | ||
| import {PathResolver} from './urlResolvers/pathResolver'; | ||
|
|
||
| import {logger} from '../util/logger'; | ||
|
|
||
| import {Config} from './config'; | ||
|
|
||
| import {DirectiveMetadata, ComponentMetadata, CodeWithSourceMap, TemplateMetadata} from './metadata'; | ||
| import {Maybe, unwrapFirst, ifTrue,} from '../util/function'; | ||
| import { | ||
| callExpression, withIdentifier, hasProperties, | ||
| isSimpleTemplateString, getStringInitializerFromProperty, decoratorArgument | ||
| } from '../util/astQuery'; | ||
| import {getTemplate, getInlineStyle} from '../util/ngQuery'; | ||
|
|
||
| const normalizeTransformed = (t: CodeWithSourceMap) => { | ||
| if (!t.map) { | ||
| t.source = t.code; | ||
| } | ||
| return t; | ||
| }; | ||
|
|
||
|
|
||
| /** | ||
| * For async implementation https://gist.github.com/mgechev/6f2245c0dfb38539cc606ea9211ecb37 | ||
| */ | ||
| export class MetadataReader { | ||
|
|
||
| constructor(private _fileResolver: FileResolver, private _urlResolver?: AbstractResolver) { | ||
| this._urlResolver = this._urlResolver || new UrlResolver(new PathResolver()); | ||
| } | ||
|
|
||
| read(d: ts.ClassDeclaration): DirectiveMetadata { | ||
| let componentMetadata = unwrapFirst( | ||
| (d.decorators || ([] as ts.Decorator[])).map((dec: ts.Decorator) => { | ||
| return Maybe.lift(dec).bind(callExpression) | ||
| .bind(withIdentifier('Component')) | ||
| .fmap(() => this.readComponentMetadata(d, dec)); | ||
| })); | ||
|
|
||
| let directiveMetadata = unwrapFirst( | ||
| (d.decorators || ([] as ts.Decorator[])).map((dec: ts.Decorator) => | ||
| Maybe.lift(dec) | ||
| .bind(callExpression) | ||
| .bind(withIdentifier('Directive')) | ||
| .fmap(() => this.readDirectiveMetadata(d, dec)) | ||
| )); | ||
|
|
||
| return directiveMetadata || componentMetadata || undefined; | ||
| } | ||
|
|
||
| readDirectiveMetadata(d: ts.ClassDeclaration, dec: ts.Decorator): DirectiveMetadata { | ||
|
|
||
| const selector = this.getDecoratorArgument(dec) | ||
| .bind(expr => getStringInitializerFromProperty('selector', expr.properties)) | ||
| .fmap(initializer => initializer.text); | ||
|
|
||
| return Object.assign(new DirectiveMetadata(), { | ||
| controller: d, | ||
| decorator: dec, | ||
| selector: selector.unwrap(), | ||
| }); | ||
| } | ||
|
|
||
| readComponentTemplateMetadata(dec: ts.Decorator, external: MetadataUrls): TemplateMetadata { | ||
| const template_M = getTemplate(dec) | ||
| .fmap(inlineTemplate => { | ||
| const transformed = normalizeTransformed(Config.transformTemplate(inlineTemplate.text, null, dec)); | ||
| return { | ||
| template: transformed, | ||
| url: null, | ||
| node: inlineTemplate, | ||
| }; | ||
| }); | ||
|
|
||
| if (template_M.isSomething) { | ||
| return template_M.unwrap(); | ||
| } else { | ||
| // TODO: Refactoring this requires adding seem to fileResolver | ||
| if (external.templateUrl) { | ||
| try { | ||
| const template = this._fileResolver.resolve(external.templateUrl); | ||
| const transformed = normalizeTransformed(Config.transformTemplate(template, external.templateUrl, dec)); | ||
| return { | ||
| template: transformed, | ||
| url: external.templateUrl, | ||
| node: null | ||
| }; | ||
| } catch (e) { | ||
| logger.info('Cannot read the external template ' + external.templateUrl); | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| readComponentStylesMetadata(dec: ts.Decorator, external: MetadataUrls) { | ||
| let styles: any[]; | ||
| const inlineStyles_M = getInlineStyle(dec) | ||
| .fmap(inlineStyles => { | ||
| return inlineStyles.elements.map((inlineStyle: ts.Expression) => { | ||
| if (isSimpleTemplateString(inlineStyle)) { | ||
|
There was a problem hiding this comment. Maybe we can first apply |
||
| return { | ||
| style: normalizeTransformed(Config.transformStyle(inlineStyle.text, null, dec)), | ||
| url: null, | ||
| node: inlineStyle, | ||
| }; | ||
| } | ||
| }).filter(v => !!v); | ||
| }); | ||
|
|
||
| if (inlineStyles_M.isSomething) { | ||
| return inlineStyles_M.unwrap(); | ||
| } else if (external.styleUrls) { | ||
| // TODO: Refactoring this requires adding seem to fileResolver | ||
| try { | ||
| styles = <any>external.styleUrls.map((url: string) => { | ||
| const style = this._fileResolver.resolve(url); | ||
| const transformed = normalizeTransformed(Config.transformStyle(style, url, dec)); | ||
| return { | ||
| style: transformed, url, | ||
| node: null | ||
| }; | ||
| }); | ||
| } catch (e) { | ||
| logger.info('Unable to read external style. ' + e.toString()); | ||
| } | ||
| } | ||
| return styles; | ||
| } | ||
|
|
||
| readComponentMetadata(d: ts.ClassDeclaration, dec: ts.Decorator) { | ||
| const expr = this.getDecoratorArgument(dec); | ||
| const directiveMetadata = this.readDirectiveMetadata(d, dec); | ||
|
|
||
| const external_M = expr.fmap(() => this._urlResolver.resolve(dec)); | ||
|
|
||
| const template_M = external_M.fmap( | ||
| (external) => this.readComponentTemplateMetadata(dec, external)); | ||
| const style_M = external_M.fmap( | ||
|
There was a problem hiding this comment. I notice that |
||
| (external) => this.readComponentStylesMetadata(dec, external)); | ||
|
|
||
| return Object.assign(new ComponentMetadata(), directiveMetadata, { | ||
| template: template_M.unwrap(), | ||
| styles: style_M.unwrap(), | ||
| }); | ||
| } | ||
|
|
||
| protected getDecoratorArgument(decorator: ts.Decorator): Maybe<ts.ObjectLiteralExpression> { | ||
| return decoratorArgument(decorator) | ||
| .bind(ifTrue(hasProperties)); | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,36 +1,40 @@ | ||
| import * as Lint from 'tslint'; | ||
| import * as ts from 'typescript'; | ||
| import {sprintf} from 'sprintf-js'; | ||
| import {ComponentMetadata} from './angular/metadata'; | ||
| import {Failure} from './walkerFactory/walkerFactory'; | ||
| import {all, validateComponent} from './walkerFactory/walkerFn'; | ||
| import {Maybe, F2} from './util/function'; | ||
| import {IOptions} from 'tslint'; | ||
| import {Ng2Walker} from './angular/ng2Walker'; | ||
|
|
||
| export class Rule extends Lint.Rules.AbstractRule { | ||
|
|
||
| static FAILURE: string = 'The name of the class %s should end with the suffix %s ($$02-03$$)'; | ||
|
|
||
| static validate(className: string, suffixList: string[]): boolean { | ||
| return suffixList.some(suffix => className.endsWith(suffix)); | ||
| } | ||
|
|
||
| static walkerBuilder: F2<ts.SourceFile, IOptions, Ng2Walker> = | ||
| all( | ||
| validateComponent((meta: ComponentMetadata, suffixList?: string[]) => | ||
| Maybe.lift(meta.controller) | ||
| .fmap(controller => controller.name) | ||
| .fmap(name => { | ||
| const className = name.text; | ||
| const _suffixList = suffixList.length > 0 ? suffixList : ['Component']; | ||
| if (!Rule.validate(className, _suffixList)) { | ||
| return [new Failure(name, sprintf(Rule.FAILURE, className, _suffixList))]; | ||
| } | ||
| }) | ||
| )); | ||
|
|
||
| public apply(sourceFile: ts.SourceFile): Lint.RuleFailure[] { | ||
| return this.applyWithWalker( | ||
| Rule.walkerBuilder(sourceFile, this.getOptions()) | ||
| ); | ||
| } | ||
| } | ||
|
|
||
|
|
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks beautiful!