csspin_frontend.jsconfig

csspin_frontend.jsconfig is a plugin that provides a task to create a jsconfig.json file for a project. This file can be interpreted by IDEs like Visual Studio Code to provide better IntelliSense support for JavaScript and TypeScript projects.

How to setup the csspin_frontend.jsconfig plugin?

For using the csspin_frontend.jsconfig plugin, a project’s spinfile.yaml must at least contain the following configuration.

Minimal configuration of spinfile.yaml to use csspin_frontend.jsconfig

plugin_packages:
    - csspin-python
    - csspin-frontend
plugins:
    - csspin_frontend.jsconfig
python:
    version: '3.11.9'

The provisioning of the required virtual environment as well as the plugins dependencies can be done via the well-known spin provision-command.

How to run the jsconfig task using csspin_frontend.jsconfig?

After the project is provisioned, the jsconfig task can be run to create a jsconfig.json file in the project root:

Running the jsconfig task

spin jsconfig

csspin_frontend.jsconfig schema reference

jsconfig: 'object'

Configuration of the jsconfig plugin.

jsconfig.includes: 'list'

List of source paths of the current JS project

jsconfig.excludes: 'list'

List of source paths to JS projects to exclude from searching of package.json

jsconfig.search_dirs: 'list'

Relative paths to directories to search JS projects to be mapped to JS modules in jsconfig.json:compilerOptions.paths. Contains python.site_packages per default.

jsconfig.base_url: 'str'

The path to the current JS project

jsconfig.schema: 'object'

jsconfig.requires: 'object'

jsconfig.requires.spin: 'list'

jsconfig._requires: 'list'