Generate Docs command (and toolbar icon)

allanbowe commented 1 year ago

We need the ability to generate docs for a target in the same way as we do for the sasjs doc command (https://cli.sasjs.io/doc)

Ideally this would somehow include the doxygen dependency, but if that's not possible, then we could at least make the doxy PATH configurable.

allanbowe commented 1 year ago

Some additional comments following the first iteration:

If the current project is not a SASjs project, we should navigate up the directory tree to see if any higher-level folders contain a SASjs project (identified by a sasjs/sasjsconfig.json file)
If there is no SASjs project then we should initialise sasjs doc in the current directory INCLUDING a sasjs/sasjsconfig.json file
We should switch the default target to the newly created defaultTarget below. The value under jobFolders should be the current directory / project root.

Initial doc projectTarget:

{
  "$schema": "https://raw.githubusercontent.com/sasjs/utils/main/src/types/sasjsconfig-schema.json",
  "jobConfig": {
    "jobFolders": [
      "/path/to project root"
    ]
  },
  "defaultTarget": "sasjsdoc",
  "targets": [
    {
      "name": "sasjsdoc",
      "serverUrl": "",
      "serverType": "SASJS",
      "appLoc": "/Public/app/docs",
    }
  ]
}

sasjsbot commented 1 year ago

:tada: This issue has been resolved in version 1.26.0 :tada:

The release is available on:

Your semantic-release bot :package::rocket:

sasjs / vscode-extension

Generate Docs command (and toolbar icon) #371