Arcanist Technical Documentation
Updated TodayPublic

Technical documentation for developing Arcanist.

Lint

ArcanistAbstractMethodBodyXHPASTLinterRuleClassArcanistAbstractMethodBodyXHPASTLinterRuleTestCaseClassArcanistAbstractPrivateMethodXHPASTLinterRuleClassArcanistAbstractPrivateMethodXHPASTLinterRuleTestCaseClassArcanistAliasFunctionXHPASTLinterRuleClassArcanistAliasFunctionXHPASTLinterRuleTestCaseClassArcanistArrayCombineXHPASTLinterRuleClassArcanistArrayCombineXHPASTLinterRuleTestCaseClassArcanistArrayIndexSpacingXHPASTLinterRuleClassArcanistArrayIndexSpacingXHPASTLinterRuleTestCaseClassArcanistArraySeparatorXHPASTLinterRuleClassArcanistArraySeparatorXHPASTLinterRuleTestCaseClassArcanistArrayValueXHPASTLinterRuleClassArcanistArrayValueXHPASTLinterRuleTestCaseClassArcanistBaseXHPASTLinterClassArcanistBinaryExpressionSpacingXHPASTLinterRuleClassArcanistBinaryExpressionSpacingXHPASTLinterRuleTestCaseClassArcanistBinaryNumericScalarCasingXHPASTLinterRuleClassArcanistBinaryNumericScalarCasingXHPASTLinterRuleTestCaseClassArcanistBlacklistedFunctionXHPASTLinterRuleClassArcanistBlacklistedFunctionXHPASTLinterRuleTestCaseClassArcanistBraceFormattingXHPASTLinterRuleClassArcanistBraceFormattingXHPASTLinterRuleTestCaseClassArcanistCallParenthesesXHPASTLinterRuleClassArcanistCallParenthesesXHPASTLinterRuleTestCaseClassArcanistCallTimePassByReferenceXHPASTLinterRuleClassArcanistCallTimePassByReferenceXHPASTLinterRuleTestCaseClassArcanistCastSpacingXHPASTLinterRuleClassArcanistCastSpacingXHPASTLinterRuleTestCaseClassArcanistCheckstyleXMLLintRendererClassShows lint messages to the user.ArcanistChmodLinterClassEnsures that files are not executable unless they are either binary or contain a shebang.ArcanistChmodLinterTestCaseClassArcanistClassExtendsObjectXHPASTLinterRuleClassArcanistClassExtendsObjectXHPASTLinterRuleTestCaseClassArcanistClassFilenameMismatchXHPASTLinterRuleClassLint that if the file declares exactly one interface or class, the name of the file matches the name of the class, unless the class name is funky like an XHP element.ArcanistClassMustBeDeclaredAbstractXHPASTLinterRuleClassArcanistClassMustBeDeclaredAbstractXHPASTLinterRuleTestCaseClassArcanistClassNameLiteralXHPASTLinterRuleClassArcanistClassNameLiteralXHPASTLinterRuleTestCaseClassArcanistClosureLinterClassUses `gjslint` to detect errors and potential problems in JavaScript code.ArcanistClosureLinterTestCaseClassArcanistCoffeeLintLinterClassArcanistCoffeeLintLinterTestCaseClassArcanistCommentSpacingXHPASTLinterRuleClassArcanistCommentStyleXHPASTLinterRuleClassArcanistCommentStyleXHPASTLinterRuleTestCaseClassArcanistCompilerLintRendererClassShows lint messages to the user.ArcanistComposerLinterClassArcanistComprehensiveLintEngineClassBasic lint engine which just applies several linters based on the file types.ArcanistConcatenationOperatorXHPASTLinterRuleClassArcanistConcatenationOperatorXHPASTLinterRuleTestCaseClassArcanistConfigurationDrivenLintEngineClassArcanistConsoleLintRendererClassShows lint messages to the user.ArcanistConsoleLintRendererTestCaseClassArcanistConstructorParenthesesXHPASTLinterRuleClassArcanistConstructorParenthesesXHPASTLinterRuleTestCaseClassArcanistControlStatementSpacingXHPASTLinterRuleClassArcanistControlStatementSpacingXHPASTLinterRuleTestCaseClassArcanistCppcheckLinterClassUses Cppcheck to do basic checks in a C++ file.ArcanistCppcheckLinterTestCaseClassArcanistCpplintLinterClassUses Google's `cpplint.py` to check code.ArcanistCpplintLinterTestCaseClassArcanistCSharpLinterClassC# linter for Arcanist.ArcanistCSSLintLinterClassUses "CSS Lint" to detect checkstyle errors in CSS code.ArcanistCSSLintLinterTestCaseClassArcanistCurlyBraceArrayIndexXHPASTLinterRuleClassArcanistCurlyBraceArrayIndexXHPASTLinterRuleTestCaseClassArcanistDeclarationParenthesesXHPASTLinterRuleClassArcanistDeclarationParenthesesXHPASTLinterRuleTestCaseClassArcanistDefaultParametersXHPASTLinterRuleClassArcanistDefaultParametersXHPASTLinterRuleTestCaseClassArcanistDeprecationXHPASTLinterRuleClassArcanistDeprecationXHPASTLinterRuleTestCaseClassArcanistDoubleQuoteXHPASTLinterRuleClassArcanistDoubleQuoteXHPASTLinterRuleTestCaseClassArcanistDuplicateKeysInArrayXHPASTLinterRuleClassFinds duplicate keys in array initializers, as in `array(1 => 'anything', 1 => 'foo')`. Since the first entry is ignored, this is almost certainly an error.ArcanistDuplicateKeysInArrayXHPASTLinterRuleTestCaseClassArcanistDuplicateSwitchCaseXHPASTLinterRuleClassArcanistDuplicateSwitchCaseXHPASTLinterRuleTestCaseClassArcanistDynamicDefineXHPASTLinterRuleClassArcanistDynamicDefineXHPASTLinterRuleTestCaseClassArcanistElseIfUsageXHPASTLinterRuleClassArcanistElseIfUsageXHPASTLinterRuleTestCaseClassArcanistEmptyFileXHPASTLinterRuleClassArcanistEmptyStatementXHPASTLinterRuleClassArcanistEmptyStatementXHPASTLinterRuleTestCaseClassArcanistExitExpressionXHPASTLinterRuleClassExit is parsed as an expression, but using it as such is almost always wrong. That is, this is valid:ArcanistExitExpressionXHPASTLinterRuleTestCaseClassArcanistExternalLinterClassBase class for linters which operate by invoking an external program and parsing results.ArcanistExternalLinterTestCaseClassArcanistExtractUseXHPASTLinterRuleClassArcanistExtractUseXHPASTLinterRuleTestCaseClassArcanistFilenameLinterClassStifles creativity in choosing imaginative file names.ArcanistFilenameLinterTestCaseClassArcanistFlake8LinterClassUses "flake8" to detect various errors in Python code. Requires version 1.7.0 or newer of flake8.ArcanistFlake8LinterTestCaseClassArcanistFormattedStringXHPASTLinterRuleClassArcanistFormattedStringXHPASTLinterRuleTestCaseClassArcanistFunctionCallShouldBeTypeCastXHPASTLinterRuleClassArcanistFunctionCallShouldBeTypeCastXHPASTLinterRuleTestCaseClassArcanistFutureLinterClassArcanistGeneratedLinterClassStops other linters from running on generated code.ArcanistGeneratedLinterTestCaseClassArcanistGlobalVariableXHPASTLinterRuleClassArcanistGlobalVariableXHPASTLinterRuleTestCaseClassArcanistGoLintLinterClassArcanistGoLintLinterTestCaseClassArcanistHexadecimalNumericScalarCasingXHPASTLinterRuleClassArcanistHexadecimalNumericScalarCasingXHPASTLinterRuleTestCaseClassArcanistHLintLinterClassCalls `hlint` and parses its results.ArcanistHLintLinterTestCaseClassArcanistImplicitConstructorXHPASTLinterRuleClassArcanistImplicitConstructorXHPASTLinterRuleTestCaseClassArcanistImplicitFallthroughXHPASTLinterRuleClassArcanistImplicitFallthroughXHPASTLinterRuleTestCaseClassArcanistImplicitVisibilityXHPASTLinterRuleClassArcanistImplicitVisibilityXHPASTLinterRuleTestCaseClassArcanistInlineHTMLXHPASTLinterRuleClassArcanistInlineHTMLXHPASTLinterRuleTestCaseClassArcanistInnerFunctionXHPASTLinterRuleClassArcanistInnerFunctionXHPASTLinterRuleTestCaseClassArcanistInstanceOfOperatorXHPASTLinterRuleClassArcanistInstanceofOperatorXHPASTLinterRuleTestCaseClassArcanistInterfaceAbstractMethodXHPASTLinterRuleClassArcanistInterfaceAbstractMethodXHPASTLinterRuleTestCaseClassArcanistInterfaceMethodBodyXHPASTLinterRuleClassArcanistInterfaceMethodBodyXHPASTLinterRuleTestCaseClassArcanistInvalidDefaultParameterXHPASTLinterRuleClassArcanistInvalidDefaultParameterXHPASTLinterRuleTestCaseClassArcanistInvalidModifiersXHPASTLinterRuleClassArcanistInvalidModifiersXHPASTLinterRuleTestCaseClassArcanistInvalidOctalNumericScalarXHPASTLinterRuleClassArcanistInvalidOctalNumericScalarXHPASTLinterRuleTestCaseClassArcanistIsAShouldBeInstanceOfXHPASTLinterRuleClassArcanistIsAShouldBeInstanceOfXHPASTLinterRuleTestCaseClassArcanistJscsLinterClassArcanistJscsLinterTestCaseClassArcanistJSHintLinterClassUses JSHint to detect errors and potential problems in JavaScript code.ArcanistJSHintLinterTestCaseClassArcanistJSONLinterClassA linter for JSON files.ArcanistJSONLinterTestCaseClassArcanistJSONLintLinterClassA linter for JSON files.ArcanistJSONLintLinterTestCaseClassArcanistJSONLintRendererClassShows lint messages to the user.ArcanistKeywordCasingXHPASTLinterRuleClassArcanistKeywordCasingXHPASTLinterRuleTestCaseClassArcanistLambdaFuncFunctionXHPASTLinterRuleClassArcanistLambdaFuncFunctionXHPASTLinterRuleTestCaseClassArcanistLanguageConstructParenthesesXHPASTLinterRuleClassArcanistLanguageConstructParenthesesXHPASTLinterRuleTestCaseClassArcanistLesscLinterClassA linter for LESSCSS files.ArcanistLesscLinterTestCaseClassArcanistLintEngineClassManages lint execution. When you run 'arc lint' or 'arc diff', Arcanist attempts to run lint rules using a lint engine.ArcanistLinterClassImplements lint rules, like syntax checks for a specific language.ArcanistLinterStandardClassA "linter standard" is a collection of linter rules with associated severities and configuration.ArcanistLinterStandardTestCaseClassArcanistLinterTestCaseClassFacilitates implementation of test cases for @{class:ArcanistLinter}s.ArcanistLintMessageClassMessage emitted by a linter, like an error or warning.ArcanistLintMessageTestCaseClassArcanistLintPatcherClassApplies lint patches to the working copy.ArcanistLintRendererClassShows lint messages to the user.ArcanistLintResultClassA group of @{class:ArcanistLintMessage}s that apply to a file.ArcanistLintSeverityClassDescribes the severity of an @{class:ArcanistLintMessage}.ArcanistListAssignmentXHPASTLinterRuleClassArcanistListAssignmentXHPASTLinterRuleTestCaseClassArcanistLogicalOperatorsXHPASTLinterRuleClassArcanistLogicalOperatorsXHPASTLinterRuleTestCaseClassArcanistLowercaseFunctionsXHPASTLinterRuleClassArcanistLowercaseFunctionsXHPASTLinterRuleTestCaseClassArcanistMergeConflictLinterClassChecks files for unresolved merge conflicts.ArcanistMergeConflictLinterTestCaseClassArcanistMissingLinterExceptionClassArcanistModifierOrderingXHPASTLinterRuleClassArcanistModifierOrderingXHPASTLinterRuleTestCaseClassArcanistNamespaceFirstStatementXHPASTLinterRuleClassArcanistNamespaceFirstStatementXHPASTLinterRuleTestCaseClassArcanistNamingConventionsXHPASTLinterRuleClassArcanistNamingConventionsXHPASTLinterRuleTestCaseClassArcanistNestedNamespacesXHPASTLinterRuleClassArcanistNestedNamespacesXHPASTLinterRuleTestCaseClassArcanistNewlineAfterOpenTagXHPASTLinterRuleClassArcanistNewlineAfterOpenTagXHPASTLinterRuleTestCaseClassArcanistNoLintLinterClassStops other linters from running on code marked with a nolint annotation.ArcanistNoLintLinterTestCaseClassArcanistNoneLintRendererClassArcanistNoParentScopeXHPASTLinterRuleClassArcanistNoParentScopeXHPASTLinterRuleTestCaseClassArcanistObjectOperatorSpacingXHPASTLinterRuleClassArcanistObjectOperatorSpacingXHPASTLinterRuleTestCaseClassArcanistPaamayimNekudotayimSpacingXHPASTLinterRuleClassArcanistPaamayimNekudotayimSpacingXHPASTLinterRuleTestCaseClassArcanistParenthesesSpacingXHPASTLinterRuleClassArcanistParenthesesSpacingXHPASTLinterRuleTestCaseClassArcanistParentMemberReferenceXHPASTLinterRuleClassArcanistParentMemberReferenceXHPASTLinterRuleTestCaseClassArcanistParseStrUseXHPASTLinterRuleClassArcanistParseStrUseXHPASTLinterRuleTestCaseClassArcanistPEP8LinterClassUses "pep8.py" to enforce PEP8 rules for Python.ArcanistPEP8LinterTestCaseClassArcanistPHPCloseTagXHPASTLinterRuleClassArcanistPHPCloseTagXHPASTLinterRuleTestCaseClassArcanistPHPCompatibilityXHPASTLinterRuleClassArcanistPHPCompatibilityXHPASTLinterRuleTestCaseClassArcanistPhpcsLinterClassUses "PHP_CodeSniffer" to detect checkstyle errors in PHP code.ArcanistPhpcsLinterTestCaseClassArcanistPHPEchoTagXHPASTLinterRuleClassArcanistPHPEchoTagXHPASTLinterRuleTestCaseClassArcanistPhpLinterClassUses "php -l" to detect syntax errors in PHP code.ArcanistPhpLinterTestCaseClassArcanistPHPOpenTagXHPASTLinterRuleClassArcanistPHPOpenTagXHPASTLinterRuleTestCaseClassArcanistPHPShortTagXHPASTLinterRuleClassArcanistPHPShortTagXHPASTLinterRuleTestCaseClassArcanistPhutilLibraryLinterClassApplies lint rules for Phutil libraries. We enforce three rules:ArcanistPhutilXHPASTLinterStandardClassArcanistPlusOperatorOnStringsXHPASTLinterRuleClassArcanistPlusOperatorOnStringsXHPASTLinterRuleTestCaseClassArcanistPregQuoteMisuseXHPASTLinterRuleClass@{function:preg_quote} takes two arguments, but the second one is optional because it is possible to use `()`, `[]` or `{}` as regular expression delimiters. If you don't pass a second argument, you're probably going to get something wrong.ArcanistPregQuoteMisuseXHPASTLinterRuleTestCaseClassArcanistPublicPropertyXHPASTLinterRuleClassArcanistPublicPropertyXHPASTLinterRuleTestCaseClassArcanistPuppetLintLinterClassA linter for Puppet files.ArcanistPuppetLintLinterTestCaseClassArcanistPyFlakesLinterClassUses "PyFlakes" to detect various errors in Python code.ArcanistPyFlakesLinterTestCaseClassArcanistPyLintLinterClassUses "PyLint" to detect various errors in Python code.ArcanistPyLintLinterTestCaseClassArcanistRaggedClassTreeEdgeXHPASTLinterRuleClassArcanistRaggedClassTreeEdgeXHPASTLinterRuleTestCaseClassArcanistReusedAsIteratorXHPASTLinterRuleClassArcanistReusedAsIteratorXHPASTLinterRuleTestCaseClassArcanistReusedIteratorReferenceXHPASTLinterRuleClassFind cases where a `foreach` loop is being iterated using a variable reference and the same variable is used outside of the loop without calling `unset()` or reassigning the variable to another variable reference.ArcanistReusedIteratorReferenceXHPASTLinterRuleTestCaseClassArcanistReusedIteratorXHPASTLinterRuleClassFind cases where loops get nested inside each other but use the same iterator variable. For example:ArcanistReusedIteratorXHPASTLinterRuleTestCaseClassArcanistRuboCopLinterClassArcanistRuboCopLinterTestCaseClassArcanistRubyLinterClassUses `ruby` to detect various errors in Ruby code.ArcanistRubyLinterTestCaseClassArcanistScriptAndRegexLinterClassSimple glue linter which runs some script on each path, and then uses a regex to parse lint messages from the script's output. (This linter uses a script and a regex to interpret the results of some real linter, it does not itself lint both scripts and regexes).ArcanistSelfClassReferenceXHPASTLinterRuleClassArcanistSelfClassReferenceXHPASTLinterRuleTestCaseClassArcanistSelfMemberReferenceXHPASTLinterRuleClassArcanistSelfMemberReferenceXHPASTLinterRuleTestCaseClassArcanistSemicolonSpacingXHPASTLinterRuleClassArcanistSemicolonSpacingXHPASTLinterRuleTestCaseClassArcanistSingleLintEngineClassRun a single linter on every path unconditionally. This is a glue engine for linters like @{class:ArcanistScriptAndRegexLinter}, if you are averse to writing a phutil library. Your linter will receive every path, including paths which have been moved or deleted.ArcanistSlownessXHPASTLinterRuleClassArcanistSlownessXHPASTLinterRuleTestCaseClassArcanistSpellingLinterClassEnforces basic spelling. Spelling inside code is actually pretty hard to get right without false positives. I take a conservative approach and just use a blacklisted set of words that are commonly spelled incorrectly.ArcanistSpellingLinterTestCaseClassArcanistStaticThisXHPASTLinterRuleClassArcanistStaticThisXHPASTLinterRuleTestCaseClassArcanistSummaryLintRendererClassShows lint messages to the user.ArcanistSyntaxErrorXHPASTLinterRuleClassArcanistTautologicalExpressionXHPASTLinterRuleClassArcanistTautologicalExpressionXHPASTLinterRuleTestCaseClassArcanistTestXHPASTLintSwitchHookClassArcanistTextLinterClassEnforces basic text file rules.ArcanistTextLinterTestCaseClassArcanistThisReassignmentXHPASTLinterRuleClassArcanistThisReassignmentXHPASTLinterRuleTestCaseClassArcanistTodoCommentXHPASTLinterRuleClassArcanistTodoCommentXHPASTLinterRuleTestCaseClassArcanistToStringExceptionXHPASTLinterRuleClassArcanistToStringExceptionXHPASTLinterRuleTestCaseClassArcanistUnableToParseXHPASTLinterRuleClassArcanistUnaryPostfixExpressionSpacingXHPASTLinterRuleClassArcanistUnaryPostfixExpressionSpacingXHPASTLinterRuleTestCaseClassArcanistUnaryPrefixExpressionSpacingXHPASTLinterRuleClassArcanistUnaryPrefixExpressionSpacingXHPASTLinterRuleTestCaseClassArcanistUndeclaredVariableXHPASTLinterRuleClassArcanistUndeclaredVariableXHPASTLinterRuleTestCaseClassArcanistUnexpectedReturnValueXHPASTLinterRuleClassArcanistUnexpectedReturnValueXHPASTLinterRuleTestCaseClassArcanistUnitTestableLintEngineClassLint engine for use in constructing test cases. See @{class:ArcanistLinterTestCase}.ArcanistUnnecessaryFinalModifierXHPASTLinterRuleClassArcanistUnnecessaryFinalModifierXHPASTLinterRuleTestCaseClassArcanistUnnecessarySemicolonXHPASTLinterRuleClassArcanistUnnecessarySymbolAliasXHPASTLinterRuleClassArcanistUnnecessarySymbolAliasXHPASTLinterRuleTestCaseClassArcanistUnsafeDynamicStringXHPASTLinterRuleClassArcanistUnsafeDynamicStringXHPASTLinterRuleTestCaseClassArcanistUselessOverridingMethodXHPASTLinterRuleClassArcanistUselessOverridingMethodXHPASTLinterRuleTestCaseClassArcanistUseStatementNamespacePrefixXHPASTLinterRuleClassArcanistUseStatementNamespacePrefixXHPASTLinterRuleTestCaseClassArcanistVariableReferenceSpacingXHPASTLinterRuleClassArcanistVariableReferenceSpacingXHPASTLinterRuleTestCaseClassArcanistVariableVariableXHPASTLinterRuleClassArcanistVariableVariableXHPASTLinterRuleTestCaseClassArcanistXHPASTLinterClassUses XHPAST to apply lint rules to PHP.ArcanistXHPASTLinterRuleClassArcanistXHPASTLinterRuleTestCaseClassFacilitates implementation of test cases for @{class:ArcanistXHPASTLinterRule}s.ArcanistXHPASTLinterTestCaseClassArcanistXHPASTLintNamingHookClassYou can extend this class and set `xhpast.naminghook` in your `.arclint` to have an opportunity to override lint results for symbol names.ArcanistXHPASTLintNamingHookTestCaseClassTest cases for @{class:ArcanistXHPASTLintNamingHook}.ArcanistXHPASTLintSwitchHookClassYou can extend this class and set `xhpast.switchhook` in your `.arclint` to have an opportunity to override results for linting `switch` statements.ArcanistXMLLinterClassA linter which uses [[http://php.net/simplexml | SimpleXML]] to detect errors and potential problems in XML files.ArcanistXMLLinterTestCaseClassTest cases were mostly taken from https://git.gnome.org/browse/libxml2/tree/test.

Unit Testing

ArcanistConfigurationDrivenUnitTestEngineClassArcanistGoTestResultParserClassGo Test Result Parsing utilityArcanistGoTestResultParserTestCaseClassTest for @{class:ArcanistGoTestResultParser}.ArcanistPhpunitTestResultParserClassPHPUnit Result Parsing utilityArcanistTestResultParserClassAbstract base class for test result parsers.ArcanistUnitConsoleRendererClassArcanistUnitRendererClassArcanistUnitTestEngineClassManages unit test execution.ArcanistUnitTestResultClassRepresents the outcome of running a unit test.ArcanistUnitTestResultTestCaseClassArcanistXUnitTestResultParserClassParser for JUnit, NUnit, etc results formatCSharpToolsTestEngineClassUses cscover (http://github.com/hach-que/cstools) to report code coverage.NoseTestEngineClassVery basic 'nose' unit test engine wrapper.PhpunitTestEngineClassPHPUnit wrapper.PhpunitTestEngineTestCaseClassTests for @{class:PhpunitTestEngine}.PhutilTestCaseClassBase test case for the very simple libphutil test framework.PhutilTestCaseTestCaseClassTest for @{class:PhutilUnitTestEngineTestCase}.PhutilTestSkippedExceptionClassThrown to skip test execution.PhutilTestTerminatedExceptionClassThrown to prematurely end test execution.PhutilUnitTestEngineClassVery basic unit test engine which runs libphutil tests.PhutilUnitTestEngineTestCaseClassVery meta test for @{class:PhutilUnitTestEngine}.PytestTestEngineClassVery basic 'py.test' unit test engine wrapper.XUnitTestEngineClassUses xUnit (http://xunit.codeplex.com/) to test C# code.XUnitTestResultParserTestCaseClassTest for @{class:ArcanistXUnitTestResultParser}.

Workflows

ArcanistAliasWorkflowClassManages aliases for commands with options.ArcanistAmendWorkflowClassSynchronizes commit messages from Differential.ArcanistAnoidWorkflowClassArcanistBackoutWorkflowClassRuns git revert and assigns a high priority task to original author.ArcanistBookmarkWorkflowClassAlias for `arc feature`.ArcanistBranchWorkflowClassAlias for `arc feature`.ArcanistBrowseWorkflowClassBrowse files or objects in the Phabricator web interface.ArcanistCallConduitWorkflowClassProvides command-line access to the Conduit API.ArcanistCapabilityNotSupportedExceptionClassArcanistCloseRevisionWorkflowClassExplicitly closes Differential revisions.ArcanistCloseWorkflowClassClose a task.ArcanistCommitWorkflowClassExecutes "svn commit" once a revision has been "Accepted".ArcanistCoverWorkflowClassCovers your professional reputation by blaming changes to locate reviewers.ArcanistDiffWorkflowClassSends changes from your working copy to Differential for code review.ArcanistDownloadWorkflowClassDownload a file from Phabricator.ArcanistExportWorkflowClassExports changes from Differential or the working copy to a file.ArcanistFeatureWorkflowClassDisplays user's Git branches or Mercurial bookmarks.ArcanistFlagWorkflowClassArcanistGetConfigWorkflowClassRead configuration settings.ArcanistHelpWorkflowClassSeduces the reader with majestic prose.ArcanistInstallCertificateWorkflowClassInstalls arcanist certificates.ArcanistLandWorkflowClassLands a branch by rebasing, merging and amending it.ArcanistLiberateWorkflowClassCreate and update libphutil libraries.ArcanistLintersWorkflowClassList available linters.ArcanistLintWorkflowClassRuns lint rules on changes.ArcanistListWorkflowClassLists open revisions in Differential.ArcanistPasteWorkflowClassUpload a chunk of text to the Paste application, or download one.ArcanistPatchWorkflowClassApplies changes from Differential or a file to the working copy.ArcanistPhrequentWorkflowClassBase workflow for Phrequent workflows.ArcanistRevertWorkflowClassRedirects to `arc backout` workflow.ArcanistSetConfigWorkflowClassWrite configuration settings.ArcanistShellCompleteWorkflowClassPowers shell-completion scripts.ArcanistStartWorkflowClassStart time tracking on an object.ArcanistStopWorkflowClassStop time tracking on an object.ArcanistTasksWorkflowClassDisplays User Tasks.ArcanistTimeWorkflowClassShow time being tracked in Phrequent.ArcanistTodoWorkflowClassQuickly create a task.ArcanistUnitWorkflowClassRuns unit tests which cover your changes.ArcanistUpgradeWorkflowClassUpgrade arcanist itself.ArcanistUploadWorkflowClassUpload a file to Phabricator.ArcanistVersionWorkflowClassDisplay the current version of Arcanist.ArcanistWhichWorkflowClassShow which revision or revisions are in the working copy.ArcanistWorkflowClassImplements a runnable command, like "arc diff" or "arc help".

Free Radicals

ArcanistBaseCommitParserClassArcanistBaseCommitParserTestCaseClassArcanistBlindlyTrustHTTPEngineExtensionClassArcanistBundleClassConverts changesets between different formats.ArcanistBundleTestCaseClassArcanistCommentRemoverClassArcanistCommentRemoverTestCaseClassArcanistConfigurationClassRuntime workflow configuration. In Arcanist, commands you type like "arc diff" or "arc lint" are called "workflows". This class allows you to add new workflows (and extend existing workflows) by subclassing it and then pointing to your subclass in your project configuration.ArcanistConfigurationManagerClassThis class holds everything related to configuration and configuration files.ArcanistDiffChangeClassRepresents a change to an individual path.ArcanistDiffChangeTypeClassDefines constants for file types and operations in changesets.ArcanistDifferentialCommitMessageClassRepresents a parsed commit message.ArcanistDifferentialCommitMessageParserExceptionClassThrown when a commit message isn't parseable.ArcanistDifferentialDependencyGraphClassArcanistDifferentialRevisionHashClassArcanistDifferentialRevisionStatusClassArcanistDiffHunkClassRepresents a contiguous set of added and removed lines in a diff.ArcanistDiffParserClassParses diffs from a working copy.ArcanistDiffParserTestCaseClassTest cases for @{class:ArcanistDiffParser}.ArcanistDiffUtilsClassDumping ground for diff- and diff-algorithm-related miscellany.ArcanistDiffUtilsTestCaseClassTest cases for @{class:ArcanistDiffUtils}.ArcanistEventTypeClassArcanistFileDataRefClassReference to a file or block of file data which can be uploaded using @{class:ArcanistFileUploader}.ArcanistFileUploaderClassUpload a list of @{class:ArcanistFileDataRef} objects over Conduit.ArcanistGitAPIClassInterfaces with Git working copies.ArcanistGitLandEngineClassArcanistGitUpstreamPathClassArcanistHgClientChannelClassChannel to a Mercurial "cmdserver" client. For a detailed description of the "cmdserver" protocol, see @{class:ArcanistHgServerChannel}. This channel implements the other half of the protocol: it decodes messages from the client and encodes messages from the server.ArcanistHgProxyClientClassClient for an @{class:ArcanistHgProxyServer}. This client talks to a PHP process which serves as a proxy in front of a Mercurial server process. The PHP proxy allows multiple clients to use the same Mercurial server.ArcanistHgProxyServerClassServer which @{class:ArcanistHgProxyClient} clients connect to. This server binds to a Mercurial working copy and creates a Mercurial process and a unix domain socket in that working copy. It listens for connections on the socket, reads commands from them, and forwards their requests to the Mercurial process. It then returns responses to the original clients.ArcanistHgServerChannelClassChannel to a Mercurial "cmdserver" server. Messages sent to the server look like this:ArcanistLandEngineClassArcanistLibraryTestCaseClassArcanistMercurialAPIClassInterfaces with the Mercurial working copies.ArcanistMercurialParserClassParses output from various "hg" commands into structured data. This class provides low-level APIs for reading "hg" output.ArcanistMercurialParserTestCaseClassArcanistNoEffectExceptionClassThrown when lint or unit tests have no effect, i.e. no paths are affected by any linter or no unit tests provide coverage.ArcanistNoEngineExceptionClassThrown when no engine is configured for linting or running unit tests.ArcanistRepositoryAPIClassInterfaces with the VCS in the working copy.ArcanistRepositoryAPIMiscTestCaseClassArcanistRepositoryAPIStateTestCaseClassArcanistSettingsClassArcanistSubversionAPIClassInterfaces with Subversion working copies.ArcanistUsageExceptionClassThrown when there is a problem with how a user is invoking a command, rather than a technical problem.ArcanistUSEnglishTranslationClassArcanistUserAbortExceptionClassThrown when the user chooses not to continue when warned that they're about to do something dangerous.ArcanistWorkingCopyIdentityClassInterfaces with basic information about the working copy.