Commands and Settings

1. List of Commands¶

This section explains the commands available in Pleasanter Code Assist.

PCA: Toggle Enable/Disable processing on save¶

A command that switches the automatic processing run when a file is saved between enabled and disabled. You can control it flexibly according to how the development work is going, and you can also control and check its state in the status bar. The state is saved in the workspace settings file and is kept after a restart.

Related Setting: pleasanter-code-assist.enabled

PCA: Insert Metadata or Extension Settings¶

A command that inserts the appropriate metadata or setting information based on the current editing context. It supports structuring and standardising the code.

PCA: Toggle Omit/Not Omit API Response Data Output¶

A command that controls the output level of the response data from the API. You can switch between detailed and concise logs according to how the development or debugging is going. The state is saved in the workspace settings file and is kept after a restart.

Related Setting: omitApiResponseDataOutput

PCA: Create Pleasanter Code Assist Directories¶

A command that automatically generates the standard directory structure needed for development. It makes the initial setup of a project more efficient and builds a consistent development environment.

PCA: Save and Sync¶

1.3.0

Up to Pleasanter Code Assist 1.2.0, saving a file was tied to syncing the file to Pleasanter.

From Pleasanter Code Assist 1.3.0, to deal with cases where an unintended sync happened, saving and syncing were separated into independent commands. Saving and automatic syncing happen only when you run the "PCA: Save and Sync" command or press the shortcut key Ctrl+S / Cmd+S.

Refer to the table below.

2. Settings¶

This section explains the settings of Pleasanter Code Assist.

• By writing them in settings.json, you can customise the behaviour of the extension.

• Note that the names are written differently when you work with settings.json through the GUI.

  Example for pleasanter-code-assist.omitApiResponseDataOutput

  It is written as "Pleasanter-code-assist: Omit Api Response Data Output".

pleasanter-code-assist.autoClearOutput¶

A setting that controls the automatic clearing of the output panel. Use it to tidy up the logs during a long development session and keep the important information easy to see.

false

pleasanter-code-assist.autoShowOutputPanel¶

A setting that controls when the output panel is shown. You can choose the display mode that suits the kind of work you do and your preference.

always

pleasanter-code-assist.caPaths¶

Specifies the path to a PEM file that contains trusted root CA certificates. (Use a file with Basic Constraints: CA:TRUE.)

1.2.0

pleasanter-code-assist.enabled¶

A setting that controls the behaviour when a file is saved. Use it when you want to disable the functions of the extension temporarily during a particular phase of the work, for example while entering and saving the meta information.

true

pleasanter-code-assist.fileExtensionMappings.css¶

Defines the extensions recognised as CSS files. You can specify several extensions.

[css]

pleasanter-code-assist.fileExtensionMappings.html¶

Defines the extensions recognised as HTML files. You can specify several extensions.

[html]

pleasanter-code-assist.fileExtensionMappings.js¶

Defines the extensions recognised as JavaScript files. You can specify several extensions.

[js]

pleasanter-code-assist.fileExtensionMappings.sql¶

Defines the extensions recognised as SQL files. You can specify several extensions.

[sql]

pleasanter-code-assist.omitApiResponseDataOutput¶

A setting that controls the output of the API response data when existing data is checked. It keeps the logs concise during normal development while letting you see the detailed data when you need it.

true

pleasanter-code-assist.showAxiosErrorResponseJson¶

When an error occurs in Axios, which is used for the communication, the response JSON (when it is available) is shown in the output panel of the extension.

1.2.0false

pleasanter-code-assist.showMessage¶

A setting that controls how information messages and error messages are shown. You can optimise the frequency of the notifications to suit your working style.

always

pleasanter-code-assist.strictSSL¶

Controls whether SSL/TLS certificates are verified. Set it to false only when Node.js cannot verify the certificate (for example in a development environment that uses a self-signed or untrusted certificate). Setting this to false disables certificate verification, so do not use it in a production environment. Note also that, even for connections through a proxy, Pleasanter Code Assist does not refer to http.proxyStrictSSL and uses only this setting.

1.2.0true

3. Settings (Visual Studio Code standard)¶

This section outlines the standard Visual Studio Code settings that Pleasanter Code Assist refers to.

• By writing them in settings.json, you can customise the behaviour of the extension.

• Note that the names are written differently when you work with settings.json through the GUI.

  Example for http.proxy

  It is written as "Http: Proxy".

http.noProxy¶

Specifies the domain names for which the proxy settings are ignored in HTTP/HTTPS requests.

1.2.0

http.proxy¶

Set the proxy to use.

1.2.0

http.proxyAuthorization¶

Sets the value of the Proxy-Authorization header sent with every network request.

1.2.0

http.systemCertificates¶

Controls whether CA certificates are read from the OS.

1.2.0true

Supported Versions¶

Related Information¶

• Pleasanter Code Assist: Creating a Work Folder by Command