CONTRIBUTING.md

Contributing

• What does the extension do?
• Setup
• Extension Configuration Files
• Sources
• Build commands
  • Internal targets

What does the extension do?

Setup

• install yarn.
• Clone the GitHub repository vscode-scheme-repl
• run yarn install to install all dependencies and development dependencies. You need the development dependencies to build and package the extension.
• run yarn --ignore-engines package - this generates the extension package vscode-scheme-repl-VERSION.vsix which you can install to VS Code

Extension Configuration Files

• ./package.json - The main extension configuration, contains VS Code commands, keybindings, configuration items, menu items, ...
• ./package_files/language-configuration.json - Set basic Scheme configuration, like opening/closing parens, word boundaries and when to indent if enter has been pressed.
• ./package_files/snippets.json - Snippets.
• ./package_files/scheme.tmGrammar.json - The syntax highlighting, a TextMate grammar.
• ./package_files/scheme.markdown.tmGrammar.json - Configuration file to get syntax highlighting in markdown Scheme code blocks.

Sources

• ./src/extension.ts - the main entry point of the extension.
• ./src/paneREPL.ts - function to deal with the visible REPL in an extra pane. E.g. to start the REPL, send a file, s-expression, ...
• ./src/sexps.ts - functions related to parsing s-expressions.
• ./src/identifierDocumentation.ts - types and functions for the handling and display of documentation.
• ./src/constants.ts - all constants used by the extension. Like config paths, command names, ...
• ./src/helpers.ts - small helper functions to make the life easier.
• ./src/functionDocumentation.ts - identifier documentation autogenerated by ./generate_function_documentation.ts. See Build commands
• ./test - tests

Build commands

The scripts field of package.json.

All yarn commands add --ignore-engines to not get a spurious warning: warning vscode-scheme-repl@VERSION:The engine "vscode" appears to be invalid.

• yarn --ignore-engines clean - deletes the directory ./out
• yarn --ignore-engines lint - runs eslint on all source files
• yarn --ignore-engines lint-github - runs eslint on all source files, writes report to ./eslint_report.json
• yarn --ignore-engines compile - compiles the Typescript sources to ./out/ and generates the source maps
• yarn --ignore-engines generate-function-doc - downloads the Chez Scheme function documentation, parses it and write the data to the file ./src/functionDocumentation.ts.
• yarn --ignore-engines test - compiles the extension and runs the tests
• yarn --ignore-engines esbuild - compiles the Typescript sources and bundles them to ./out/extension.js and adds a source map ./out/extension.js.map. This is used for testing.
• yarn --ignore-engines esbuild-watch - runs the same commands as yarn --ignore-engines esbuild-watch in watch mode, that is, it re-bundles everything if a file has been changed
• yarn --ignore-engines bundle - compiles and minifies the Typescript sources and bundles them to ./out/extension.js, no source maps are generated. This is used for releases.
• yarn --ignore-engines package - generates a VSIX package of the extension. That is, a 'normal' VS Code extension package
• yarn --ignore-engines publish-vsix - publishes the extension to the marketplace. This needs a working marketplace account and an access token. To publish interactively, you can login with your token first by calling yarn --ignore-engines vsce login YOUR_PUBLISHER_NAME, where YOUR_PUBLISHER_NAME is the account to publish the extension to.

Internal targets

• vscode:prepublish - used by yarn --ignore-engines package (by vsce package)
• esbuild-base - used by other targets that call Esbuild with additional options