All Functions and Procedures

Adds the Coverage build mode to a test project, if it does not have it, with the compiler options of the project: the same search paths, so pasc deps keeps them in sync, DWARF 3 debug info, no optimization, no heaptrc, the units in lib/coverage and the executable next to the Default one, with -coverage at the end of its name. Only the new build mode is written, the rest of the file is kept as it is. Returns false if the project already had the build mode.

Adds the source folders missing from every OtherUnitFiles of a project, in all its build modes, relative to the project and with / as separator. The existing entries are kept, so it only adds. Returns true if the project file was 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.

Returns the coverage as a percentage, zero when there are no lines.

This command runs boss install at the root of the current workspace, even when called inside a member, so the whole workspace has a single boss.json and modules folder. Then it updates the search paths of every member (and its test project) with the source folders of the installed modules, relative to each member.

boss "projects" attribute is not used because boss writes those paths relative to the workspace root, while lazarus resolves them relative to each project file.

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.

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 configuration ignores the message.

Shows the pasc license followed by the third-party notices.

Returns the name of a kind, like warning.

Reads the lint configuration of a member from the pasc.json of the workspace:

"lint": { "ignore": [5024, "PL001"], "fail": ["warning", 5091], "rules": { "PL004": { "max": 60 } }, "members": { "web": { "ignore": [5024] } } }

ignore and fail take kinds (error, warning, note, hint), message numbers and ids of rules. rules has the limits of the rules that have one. A member, by name or by folder relative to the root, adds its ignore to the one of the workspace and, when it has fail, replaces it; its rules replace the limits it has. Without pasc.json or lint, the default is returned. Raises an exception for a value that is not a kind, a number or a rule.

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.

Runs the test project found from the current directory and outputs the report. If ABuild is true the test project is built with lazbuild before running. Returns whether the tests ran and how many passed and failed.

Save AContent string in the provided file name.

Returns the members sorted so that each package comes before the members that require it. Raises an exception if there is a circular reference.

Adds the folders under src of an app member that have Pascal sources, like the feature folders of the web template, to the search paths of its project, in every build mode, and of its test project. FPC does not search the unit folders recursively, so a new folder would only fail later with "Can't find unit". Packages list their units in the .lpk and are not changed.

Updates the search paths of every workspace member and of its test project with the source folders of the modules installed by boss.

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.