All Identifiers

This command adds features to the project like a unit tests project creating a tests subfolder, or adds code documentation capabilities to the project base on pasdoc.

Adds a required package with a relative DefaultFilename to a .lpi or .lpk file. The file is changed as text to preserve its formatting. Returns false if the package was already required.

Analyzes a project and returns the plan to convert it to a workspace. Nothing is changed.

Applies a plan returned by AnalyzeAdoption. Returns the description of each change. Tracked files are moved with git mv to keep their history.

Builds the test project using lazbuild. The .lpi file with the same name of the project file is preferred if it exists. Returns true if the build succeeded.

This command checks every member of the workspace, or the project in the current folder, and its test project: folders with units that are not in the search paths of every build mode, search paths that do not exist, and for a package the units that are not in its files and the files that no longer exist. In a workspace it also checks the modules folder: out of place, missing, or without the modules of boss-lock.json. Each problem is a warning with the line to add or remove, and the exit code is 1 when there is any.

Checks a project or package and returns one warning per problem found, with the paths relative to ABaseDir. A search path under the modules folder of ABaseDir that does not exist comes with the hint to run pasc deps. Returns empty when there is nothing to fix.

Checks the modules folder of the workspace, then every member and its test project, and outputs one warning per problem. Returns the number of warnings.

This command recursively from the current path searches for folders named "lib" and "backup" to remove them. However, before removing them, it asks the user for confirmation. Confirmation that can be suppressed if the –force option is given.

This command builds the test project in the current folder, or in its tests subfolder, with the Coverage build mode, runs it under kcov and outputs the coverage of each source file of the project, without the tests and the modules. At the root of a workspace it does the same for every member with a tests folder and outputs the total. The units with code that no test uses are not seen by kcov, so they are listed as warnings. The exit code is 1 when the tests could not run, any of them failed or the coverage is below –min.

Name of the build mode added to the test projects.

Added to the name of the test executable for the Coverage build mode.

Default limit of rule PL006, in nested if, case, loops, try and with.

Default limit of rule PL004, in lines of a routine, its header included.

Generates the documentation with pasdoc, by convention: - docs/generate/introduction.txt is the introduction, and conclusion.txt the conclusion; - every other docs/generate/*.txt is an additional page; the command*.txt pages are grouped as Commands in the menu, after the other pages; - the sources are the units in the search paths of the project (.lpi or .lpk) in the current folder, and its main program; at the root of a workspace, of every member; - docs/generate/custom.css, when it exists, replaces the pasdoc stylesheet. The output goes to docs. The exit code is 1 when pasdoc is missing or fails.

Folder of the documentation pages, relative to the project root.

Returns the boss output without ANSI escape sequences. If AFilterDelphi is true the lines produced by the Delphi-only internal tools are also removed, and ANoiseFound returns true if any of them was found.

Returns the messages for the sources of a member: files in its folder, not in its lib, backup or modules folders. Each message is returned once, also when two projects of the member compile the same unit. Errors are always kept, wherever they are, because they stop the build.

Returns first ocurrence of text in format line:1 (column is always 1). It is case insensitive search. If not text is found the function returns an empty string.

Checks if specified project exists, if a project file is not provided try to find one on current directory. Returns complete file name if a project is found.

From the current directory it tries to locate a source file. Any file with .pas or .pp extension will be considered as source file. Returns the first occurence of a source file. Returns empty if not source file was found.

From the current directory it tries to locate an fpcunit compatible test project, in the current folder or in a tests subfolder. Returns the complete test project file name, or empty if the project does not exist or is not of the expected type.

Returns the first error in the output of lazbuild, the line that explains the failure among the hints and the lazbuild messages, like TestCommandGreet.pas(11,3) Fatal: Can't find unit Command.Interfaces used by TestCommandGreet. The folder of the file and the message number are removed. Returns empty if there is no error.

Returns the search paths of each build mode of a .lpi, or the search paths of a .lpk. A build mode without compiler options of its own uses the ones of the project.

Get the contents of AFileName in string.

Returns the folders under the src folder of a member, src included, that have Pascal sources (.pas, .pp or .inc), sorted. lib and backup folders are not included. Returns empty if the member has no src folder.

Returns the module folders recorded in boss-lock.json that are not in the workspace modules folder. The folder name depends on the boss version (3.x uses github_com_user_repo, older versions the repository name), so a difference means the lock was written by another boss version, and the search paths synced from this machine do not match it. Returns empty without a lock or a modules folder.

Returns the absolute files listed in the Files of a .lpk.

Process a raw string and returns an array of strings with the parameters that were separated by spaces, and consider as single parameter a string between double quotes.

Returns the names of the available templates, separated by commas.

From the current directory it tries to locate an fpcunit compatible test project that has been previously compiled. Returns complete test file executable name. If the function returns empty, the project does not exist or is not of the expected type.

Returns the units (.pas or .pp) of the given folders, not of their subfolders, that have code but are not in the report: no test uses them, so kcov does not see them and they are not counted. Sorted.

Returns true if a .lpi has a build mode with the given name, ignoring case.

Appends to the .gitignore of a folder the paths that git does not ignore yet, when the folder is in a git repository, like /coverage/. The .gitignore is created if needed, and its lines are kept. Returns the lines added.

<sumary> This class aims to interpret the memory leak trace file and produce a simpler report summarizing enough information to locate the problem at its source.

Runs boss install for each dependency at the workspace root, then updates the search paths of the members, like the deps command. Returns false, with the boss exit code in ExitCode, if boss failed.

Returns true if the message makes pasc lint fail: an error, a kind in fail or a number in fail.

Returns true if the line of the message, or the line above it, has a comment pasc-lint: ignore with the id of the message, like // pasc-lint: ignore PL001, 5024.

This command builds the project in the current folder and its test project, or at the root of a workspace every member and its test project, and outputs the messages of the compiler for their sources, as file:line:col links. The configuration in pasc.json says which messages are ignored and which ones fail; by default warnings fail. The exit code is 1 when there is a failing message or a project could not be built.

Returns the id of a message as the output shows it: the number of a message of the compiler, like 5093, or the id of a rule, like PL001; empty when there is none.

Buffer size for reading the output in chunks

Outputs a error message in console with color from CommandBuilder theme color.

Parses the output of lazbuild and returns the source files the compiler compiled, from its lines (3104) Compiling file, without the resources. A relative file name is resolved like in ParseCompilerMessages.

Prepares the members of the workspace to be built: adds the src folders of each app to its search paths, then outputs the warnings of CheckWorkspace. Used by pasc build and pasc test before calling lazbuild, so a problem shows up before the first member is built.

Returns the given relative path, of an entry of a project file that was at AOldDir and is now at ANewDir, so that it still points to the same place. Paths that point inside one of the moved folders or files are kept, as they moved together. Lazarus macros are kept.

Registry a build command using the command builder from pascli, also sets. options and usage help info.

Registry a clean command using the command builder from pascli, also sets. options and usage help info.

Registry a deps command using the command builder from pascli.

Registry a install command using the command builder from pascli, also sets. options and usage help info.

Registry a lint command using the command builder from pascli.

Registry a test command using the command builder from pascli.

A destructor that does not call inherited, which leaks what the parent frees.

A routine with more lines than the limit.

A routine with more parameters than the limit.

A with statement, which hides where each identifier comes from.

Execute the command requested by the user, it will be passed to IPathWatcher so that it executes it. It is prepared to run the project build and tests as long as there is a respective executable. .

Save AContent string in the provided file name.

Removes ANSI escape sequences (colors and cursor control) from a text.

Replaces, in every OtherUnitFiles of a .lpi or .lpk file, the paths that point to the workspace modules folder by the given module source folders, relative to the file folder. Other paths are kept. The file is changed as text to preserve its formatting. Returns true if the file was changed.

Layout detected in the project to adopt.

Result of the analysis of a project, applied by ApplyAdoption.

The search paths of a build mode.

Specific array type for console buffer for reading the output in chunks

Coverage of a source file.

Enum type to identify the type of item to be ignored by the Watcher.

<sumary> This class aims to interpret the memory leak trace file and produce a simpler report summarizing enough information to locate the problem at its source.

Kind of a message of the compiler.

A message of the compiler for a source file.

An app template.

<sumary> This class aims to interpret the fpcunit test xml file and produce a simpler report summarizing all tests cases and also providing their location on source code.

A workspace member: an app (.lpi) or a lazarus package (.lpk).

This command aims to monitor for changes in the current directory. Changes considered are new files, changes to existing files, and file deletions.

The ignored folders are the ones that start with ".", the ones named "lib", "modules", "backup". Ignored files start with ".", with no extension, .exe, .dll and .trc.

Once the change condition is satisfied, the requested commands are executed so that their output is generated in the console.

Workspace manifest file name.

Writes the files of the template to the app folder, creating the subfolders, with the app name in place of {APPNAME}. Returns the files written.