pijul nest
guest › [sign in] [explore]

Enforce documentation on every Function, Method, and Class

[?]
Dec 30, 2020, 3:55 AM
GGYKE3DVQ5DTJGVHVAUTRF2BWLGNGKUGZMKEPOVEXAND3ITBWE5AC

Dependencies

  • [2] FHP3BBQQ Update eslint settings to handle Typescript properly
  • [3] F2OLRT5V Add fileUtils.ts
  • [4] OXW4KMVU Add QuickDiffProvider
  • [5] TKKT6D4C Add failure loop to installation selection
  • [6] WW67NYZV Configure eslint for JS standard formatting
  • [7] 4PN3R2LY Fix lint/style issues
  • [8] WHFIIX4Y Improve documentation and add Pijul installation configuration
  • [*] NCBEWRYE Initialize Repository
  • [*] H6KYVQ2Q Add a class to represent resources
  • [*] B4SKYP3Y Add repository model and add steps to initialize it
  • [*] 6H4B4UJQ Add commands to open repo and global pijul configuration files
  • [*] ZGMIJNFV Create pijul.ts for executing commands using the Pijul CLI
  • [*] 6ONRFFRG First pass of file decorations
  • [*] ILH3GIVT Add command centre and refresh/init commands
  • [*] FAMBRMO7 Add command to open file to source control resources

Change contents

  • edit in src/utils/fileUtils.ts at line 4
    [3.88]
    [3.88]
    /**
    * Convert a relative path string into an absolute URI for a resource
    * @param relativePath The relative path to the resource
    */
  • edit in src/test/suite/index.ts at line 5
    [10.105103]
    [5.3320]
    /**
    * Start mocha and run all the tests in the suite
    */
  • edit in src/test/runTest.ts at line 4
    [10.106290]
    [5.3917]
    /**
    * Start tests
    */
  • edit in src/resource.ts at line 7
    [11.301]
    [11.301]
    /**
    * Create a new resource
    * @param _resourceUri The URI of the resource
    * @param status The Pijul status of the resource
    */
  • edit in src/repository.ts at line 8
    [12.230]
    [12.230]
    /**
    * The Repossitory class is the basic source control unit for the extension
    * it is responsible for the registration of most of the VS Code integrations
    * such as creating the CommandCentre, the DecorationProvider, and the QuickDiffProvider.
    */
  • edit in src/repository.ts at line 35
    [12.483]
    [12.483]
    /**
    * Creates a new Repository instance, registering the source control provider,
    * file watchers, and other core parts of the VS Code integration.
    * @param repository The underlying Pijul repository object which CLI commands go through
    * @param outputChannel The output channel where logging information will be sent
    */
  • edit in src/repository.ts at line 111
    [13.5]
    [13.5]
    /**
    * Gets a URI to the root directory of this repository.
    */
  • edit in src/pijul.ts at line 11
    [14.288]
    [14.288]
    /**
    * Interface representing the information needed to create an instance
    * of the Pijul class.
    */
  • edit in src/pijul.ts at line 30
    [14.699]
    [14.699]
    /**
    * Accessor for the onOutput event
    */
  • edit in src/pijul.ts at line 36
    [14.759]
    [14.759]
    /**
    * Create a new instance of a Pijul object
    * @param options The path to a Pijul installation and its version.
    */
  • edit in src/pijul.ts at line 148
    [4.269]
    [14.4369]
    /**
    * Create a new repository instance
    * @param _pijul The Pijul instance use to execute commands with the CLI
    * @param repositoryRoot The root directory of the repository
    */
  • edit in src/pijul.ts at line 158
    [14.4504]
    [14.4504]
    /**
    * Accessor for the underlying Pijul instance
    */
  • edit in src/pijul.ts at line 165
    [14.4557]
    [14.4557]
    /**
    * Accessor for the path to the root directory of the repository
    */
  • replacement in src/extension.ts at line 14
    [5.210]→[5.106:163](∅→∅)
    // TODO: Add lint rule to require function documentation
    [5.210]
    [5.64]
    /**
    * Check for a Pijul installation at a specific location, asking the user to
    * select one if it cannot be found.
    * @param path A path that may already have been defined in the configuration file
    * @param config The extension configuration
    * @param outputChannel The output channel where logging information should be sent
    */
  • edit in src/decorations.ts at line 15
    [15.1227]
    [15.1227]
    /**
    * Create a new PijulDecorationProvider instance
    * @param repository The repository decorations will be provided for
    */
  • edit in src/commands.ts at line 55
    [16.1642]
    [16.1642]
    /**
    * The command centre class contains resources which may need to be accessed
    * by VS Code commands. All commands are registered through the command centre
    * using the `@command` decorator. Only one should exist at a time, otherwise
    * errors will be thrown when the same commands are registered multiple times.
    */
  • edit in src/commands.ts at line 64
    [16.1709]
    [16.1709]
    /**
    * Create a new CommandCentre instance.
    * @param pijul The Pijul instance commands which do not require a repository will be run through
    * @param repository The repository that repository specific commands will be run in
    * @param outputChannel The output channel command information should be sent to
    */
  • edit in src/commands.ts at line 254
    [17.359]
    [16.3971]
    /**
    * Dispose all of the command centre's disposable resources
    */
  • replacement in .eslintrc.json at line 34
    [2.184]→[5.25095:25105](∅→∅),[5.25095]→[5.25095:25105](∅→∅)
    ]
    [2.184]
    [5.25105]
    ],
    "require-jsdoc": ["error", {
    "require": {
    "FunctionDeclaration": true,
    "MethodDefinition": true,
    "ClassDeclaration": true,
    "ArrowFunctionExpression": false,
    "FunctionExpression": false
    }
    }]