ng-parse

Parse Angular typescript files using Abstract Syntax Tree (AST).

Usage

Install with npm

npm i ng-parse

import { parseFile, parsePath } from 'ng-parse';

const parsedFile = parseFile(filePath, options);
const parsedFiles = parsePath(path, options);

ParsedFile

Both parseFile and parsePath return respectively a ParsedFile Object or Array of ParsedFile Objects.

• path: string The file path
• classes: ParsedClass[] The parsed classes in the file
• variables: ParsedVariable[] The parsed variables in the file

ParsedClass

• name: string The name of the class
• methods: ParsedMethod[] The parsed methods in the class
• properties: ParsedProperty[] | ParsedSetter[] | ParsedGetter[] The parsed properties in the class, can exist of plain properties, getters and/or setters
• setters: ParsedSetter[] The parsed setters in the class
• getters: ParsedGetter[] The parsed getters in the class
• selector?: string The selector found in the class (optional, elegible for Components and Directives)
• type?: string The type of the class (optional, mostly the decorator found on the class)

ParsedMethod

• name: string The name of the method
• type: string The return type of the method (null if not present)
• parameters: ParsedMethodParameter[] The parameters of the method
• modifiers: ts.SyntaxKind[] the modifiers of the method

ParsedMethodParameter

• name: string The name of the method parameter
• type: string The type of the method parameter (null if not present)

ParsedProperty

• modifiers: ts.SyntaxKind[] The modifiers of the property
• name: string The name of the property
• type: string The type of the property (null if not present)
• initializer: ParsedInitializer The initializer of the property (null if not present)
• kind: string The property kind

ParsedSetter

• modifiers: ts.SyntaxKind[] The modifiers of the property
• name: string The name of the property
• type: string The type of the property
• kind: string The property kind
• parameters: ParsedSetterParameter[] The parameters of the setter

ParsedSetterParameter

• name: string The name of the setter parameter
• type: string The type of the setter parameter (null if not present)
• initializer: ParsedInitializer The initializer of the setter parameter (null if not present)

ParsedGetter

• name: string The name of the getter
• type: string The type of the getter (null if not present)

ParsedVariable

• modifiers: ts.SyntaxKind[] The modifiers of the variable
• initializer: ParsedInitializer The initializer of the variable (null if not present)
• name: string The name of the variable
• type?: string The type of the variable (optional, null if not present)
• propertyName?: string The property name of the variable (optional)

ParsedInitializer

• type: string The type of the initializer (null if not present)
• value: string The value of the initializer

parseFile(filePath, [options])

The parseFile method can be used to parse a specific file

• filePath: string The path to the file, can be absolute or relative (see options)
• options: ParseFileOptions The options to configure the parseFile method (optional)

Returns a ParsedFile object

ParseFileOptions

All the options passed to configure the parseFile method are optional

• relativePath?: string If filled the passed filePath will be merged with the relativePath, (optional, default the absolute filePath is used)
• languageVersion?: ts.ScriptTarget The Typescript version of the file (optional, default Latest)

parsePath(path, [options])

The parsePath method can be used to parse multiple files by passing a path and using a minimax file matcher

• path: string The path from where the matching should start (the matcher can be set through the options)
• options: ParsePathOptions The options to configure the parsePath method (optional)

Returns an array of ParsedFile objects

ParsePathOptions

All the options passed to configure the parsePath method are optional

The ParsePathOptions type extends from the ParseFileOptions type

• relativePath?: string If filled the passed filePath will be merged with the relativePath, (optional, default the absolute filePath is used)
• languageVersion?: ts.ScriptTarget The Typescript version of the file (optional, default Latest)
• matcher: string The minimax matcher used by glob to find the files (optional, default **/*.{ts,tsx})

License

MIT © Jef Van Hoyweghen