Functions — github.com/davidquinn/psi-header

hub / github.com/davidquinn/psi-header / functions

Functions70 in github.com/davidquinn/psi-header

* Map the value of key from source to target. * Will not modify target if the property does not exist on source. * * @param {Object} source * @par

src/helper.ts:314

↓ 15 callersFunctionplaceholder

* Generate a placeholder string. * * @param {string} str * @returns {string}

src/helper.ts:1106

↓ 10 callersFunctionmapLangConfig

* Maps the values for language config properties from source to target. * Will not modify target for any property not found in source. * * @param {

src/helper.ts:277

↓ 8 callersFunctiontrimStart

(s: string)

src/helper.ts:1288

↓ 7 callersFunctionreplacePlaceholders

(source: string, variables: IVariableList, prevLine: string | null = null, zeroDate: ZeroDate = 'asIs')

src/helper.ts:764

↓ 6 callersFunctionoverrideSeparator

(path: string, separator?: string)

src/helper.ts:1293

↓ 5 callersFunctiongetProjectRootPath

* Pass in a fully qualified file path and return the part of the path where an associated package.json file is located. * Iterates up through the dir

src/helper.ts:402

↓ 4 callersFunctionaddLineSuffix

(line: string, suffix: string, wrapCol: number, tabSize: number)

src/helper.ts:792

↓ 4 callersFunctionescapeRegExp

* Escapes regular expression special characters * * @param value the string to escape

src/helper.ts:1142

↓ 4 callersFunctiongetLanguageConfig

(wsConfig: WorkspaceConfiguration, langId: string, filename: string)

src/helper.ts:218

↓ 4 callersFunctiongetMappableRecord

* Find the correct template or language config record. * * Returns the config record where the language matches either the `fileXtn` or * `langId`

src/helper.ts:133

↓ 4 callersFunctionisCompactMode

(langConfig: ILangConfig)

src/helper.ts:737

↓ 3 callersMethod_startsWith

(line: string, langPrefix: string, searchText: string)

src/changesTrackingController.ts:445

↓ 3 callersFunctionconstructFunctionReferences

* Construct a placeholder variable list for a specified function based on the template text content. * @param {IVariableList} references an existing

src/helper.ts:994

↓ 3 callersFunctiongetActiveFileCreationDate

* Return the current editor file's creation date (birthtime) *

src/helper.ts:564

↓ 3 callersFunctiongetConfig

(wsConfig: WorkspaceConfiguration, langConfig: ILangConfig)

src/helper.ts:72

↓ 3 callersFunctiongetRelativeFilePath

(fullpath: string, rootDirFileName?: string, addLeadingDot: boolean = false)

src/helper.ts:530

↓ 2 callersMethod_docNeedsHeader

* Returns true if the file appears to need a header. * * @private * @param {TextDocument} doc * @returns * @memberof ChangesTrackingControll

src/changesTrackingController.ts:402

↓ 2 callersMethod_filenameInGlobs

(filename: string, globs: string[])

src/changesTrackingController.ts:361

↓ 2 callersMethod_getConfig

* Reads the configuration and caches it in this object. * * @private * @memberof ChangesTrackingController

src/changesTrackingController.ts:291

↓ 2 callersMethod_want

* Returns true if change tracking is active for the specified language, * or if the filename matches an active glob pattern. * * @private * @p

src/changesTrackingController.ts:346

↓ 2 callersFunctionarrayToString

* Turns a string array into an EOL delimited string. * * @param {Array<string>} source * @returns {string}

src/helper.ts:752

↓ 2 callersFunctionextractFileName

* Get the filename from the file full path * * @param {string} fullpath * @returns {string}

src/helper.ts:509

↓ 2 callersFunctiongetAuthorName

(ignoreAuthorFullName: boolean)

src/helper.ts:487

↓ 2 callersFunctiongetFileCreationDate

(filename: string, zeroDate: ZeroDate = 'asIs')

src/helper.ts:578

↓ 2 callersFunctiongetIndicesOf

* Search the haystack for instances of needle and return an array of index positions. * * @param needle the value to search for * @param haystack t

src/helper.ts:1117

↓ 2 callersFunctiongetMergedVariables

(wsConfig: WorkspaceConfiguration)

src/helper.ts:1260

↓ 2 callersFunctiongetProjectName

* Get the name of the project - either from a package.json or the last part of the root project path. * * @param {string} filename The file to dete

src/helper.ts:438

↓ 2 callersFunctiongetTemplateConfig

(wsConfig: WorkspaceConfiguration, langId: string, filename: string)

src/helper.ts:165

↓ 2 callersFunctiongetVariables

(wsConfig: WorkspaceConfiguration, document: TextDocument, config: IConfig, langConfig: ILangConfig, ignoreLic

src/helper.ts:331

↓ 2 callersFunctioninsertFileHeader

()

src/insertFileHeaderCommand.ts:42

↓ 2 callersFunctiony2y

* Returns a year to year string from the passed in from and to year parameters * * @param fromArg First yeartoyear() argument text * @param toArg

src/helper.ts:941

↓ 2 callersFunctiony2yYear

* Process a year argument, which might be the special string "fc" or "now". * * @param arg The argument year, or special value "fc" or "now" * @p

src/helper.ts:921

↓ 1 callersMethod_fileIsNew

* Returns true if the file is new (created within the past 3 seconds). * * @private * @param {any} filename * @returns * @memberof ChangesTr

src/changesTrackingController.ts:378

↓ 1 callersMethod_isIgnorableLine

(line: string, ignorants: Array<string>)

src/changesTrackingController.ts:429

↓ 1 callersFunction_modifyForDayZero

* If the passed in date is Unix Epoch Zero then return the value defined by * ifZero, otherwise just return the date. * * @param {Date} date * @pa

src/helper.ts:601

↓ 1 callersMethod_wantAutoHeader

* Returns true if auto header creation is active. * * @private * @returns * @memberof ChangesTrackingController

src/changesTrackingController.ts:390

↓ 1 callersFunctionaddLicenseVariables

* Add the license and related variables from the SPDX data. * * @param {WorkspaceConfiguration} wsConfig * @param {IVariableList} variables * @par

src/helper.ts:621

↓ 1 callersFunctionbaseLangConfig

* Generate the base language configuration object. * * @param {string} langId The language id of the target file * @param {ILangConfig | undefined}

src/helper.ts:234

↓ 1 callersFunctioncaptionRowIndex

* Determines the location (line index) for the next change log. * @param doc * @param template * @param langConfig * @param naturalOrder * @p

src/insertChangeLogCommand.ts:87

↓ 1 callersFunctioncleanSpdxLicenseText

* Clean up some of the easier goo goo muck from the license text. * * @param {string} lic * @returns {string}

src/helper.ts:1064

↓ 1 callersFunctionconstructFunctionReferencesWithPrev

* Construct a placeholder variable list for a specified function based on the template text content and the existing content. * * The second argume

src/helper.ts:1021

↓ 1 callersFunctiongetEditorWordWrapColumn

(def: number = 80)

src/helper.ts:741

↓ 1 callersFunctiongetFullPathWithoutFilename

(fullpath: string)

src/helper.ts:555

↓ 1 callersFunctiongetMergedLangConfig

(wsConfig: WorkspaceConfiguration)

src/helper.ts:1224

↓ 1 callersFunctiongetMergedTemplates

(wsConfig: WorkspaceConfiguration)

src/helper.ts:1188

↓ 1 callersFunctiongetPaddingValues

(fromLine: string)

src/helper.ts:843

↓ 1 callersFunctiongetProjectVersion

* Get the name of the project - either from a package.json or the last part of the root project path. * * @param {string} filename The file to dete

src/helper.ts:463

↓ 1 callersFunctiongetRelativePathWithoutFilename

(fullpath: string, rootDirFileName?: string)

src/helper.ts:546

↓ 1 callersFunctioninsertChangeLog

()

src/insertChangeLogCommand.ts:38

↓ 1 callersFunctionmapTemplateConfig

* Maps the values for template configuration properties from source to target. * Will not modify target for any property not found in source. * * @

src/helper.ts:186

↓ 1 callersFunctionmerge

(template: Array<string>, langConfig: ILangConfig, variables: IVariableList, config: IConfig, editor: TextEdit

src/helper.ts:700

↓ 1 callersFunctionmergeLangConfigLists

* General method to merge one or more [[ILangConfigList]] arrays into a single * array that includes all of the language configuration lists from all

src/helper.ts:1236

↓ 1 callersFunctionmergeStringLists

* General method to merge one or more string arrays into a single array that * includes all of the strings from all of the passed in string arrays.

src/helper.ts:1169

↓ 1 callersFunctionmergeTemplateLists

* General method to merge one or more [[ITemplateList]] arrays into a single * array that includes all of the template lists from all of the passed i

src/helper.ts:1199

↓ 1 callersFunctionmergeVariableLists

* General method to merge one or more [[IVariableList]] arrays into a single * array that includes all of the variable lists from all of the passed i

src/helper.ts:1271

↓ 1 callersFunctionremoveFunctionCall

(functionName: string, fromLine: string)

src/helper.ts:833

↓ 1 callersFunctionreplaceFunctions

* Process template function placeholders * * @param source the template text * @param prevLine the replaced line, or null if not replacing * @para

src/helper.ts:872

↓ 1 callersFunctionreplaceTemplateVariables

(template: Array<string>, linePrefix: string, variables: IVariableList, zeroDate: ZeroDate)

src/helper.ts:683

↓ 1 callersFunctionretrieveAuthorFullName

()

src/helper.ts:495

↓ 1 callersFunctionsafeParseInt

(s: string, fallback: number)

src/helper.ts:859

↓ 1 callersFunctionwordWrap

* Wrap the word wrap wrapper in a wrapper that wraps words. (No rap!) * * @param {string} str * @param {number} width * @returns {Array<string>}

src/helper.ts:1094

Method_onConfigChanged

* Re-reads the configuration settings. * * @private * @memberof ChangesTrackingController

src/changesTrackingController.ts:253

Method_onDidChangeActiveTextEditor

* Called whenever the active editor is changed. * This controls automatic adding of headers to new files. * * @private * @param {TextEditor} e

src/changesTrackingController.ts:265

Method_onWillSave

* Delegate method triggered whenever a document will be saved. * Used to update an existing header or force a header if enforceHeader is true. *

src/changesTrackingController.ts:116

Functionactivate

(context: ExtensionContext)

src/extension.ts:42

Methodconstructor

* Creates an instance of ChangesTrackingController. * @memberof ChangesTrackingController

src/changesTrackingController.ts:90

* Dispose of the ChangesTrackingController. * * @memberof ChangesTrackingController

src/changesTrackingController.ts:104

FunctiongetMergedStrings

(wsConfig: WorkspaceConfiguration, key: string)

src/helper.ts:1157