This project is intended bring together both the internal and external SAP development communities to build and improve on an extension that provides streamlined access to a wide variety of development resources. Our goal is help our users understand what is possible with their SAP projects and then help them implement it.
Ensure that the minimum system requirements for installing Visual Studio Code are met. For more information, see Requirements for Visual Studio Code.
To install pnpm globally using npm, run the following:
npm install -g pnpmMore information on pnpm installation options can be found here.
To install dependencies and devDependencies, run following command at root of the repository:
pnpm installTo transpile the packages, run the following command at the root of the repository or in the individual package:
pnpm buildTo format sources, run the following command at the root of the repository or in the individual package:
pnpm formatTo run linting of sources, run the following command at the root of the repository or in the individual package:
pnpm lintTo fix linting errors that can be fixed automatically, run the following command at the root of the repository or in the individual package:
pnpm lint:fixTo run unit tests using jest, run the following command at the root of the repository or in the individual package:
pnpm testNote: if the test run fails due to dependency issues, run pnpm install && pnpm build in the root of the repository again to make sure all projects are up-to-date.
When analyzing a problem, it is helpful to be able to debug the modules. How to debug them depends on the IDE you are using. In this section, it is described how you could debug with VSCode.
Each of the packages has an extensive set of unit tests covering as many as possible different scenarios, therefore, as a starting point for debugging, it is a good idea to use the tests. The easiest (but not the only) way to debug a specific test in VSCode is to open a JavaScript Debug Terminal and then go to the package that needs to be debugged. Using the debug terminal, execute all tests with pnpm test.
A changeset workflow has been setup to version and publish packages to npmjs.com. To create changesets in a feature or bug fix branch, run one of the following commands:
pnpm csetpnpm changesetThis command brings up an inquirer.js style command line interface with prompts to capture changed packages, bump versions (patch, minor or major) and a message to be included in the changelog files. The changeset configuration files in the .changeset folder at the root need to be committed and pushed to the branch. These files will be used in the GitHub Actions workflow to bump versions and publish the packages.
The general recommendation is to run this changeset command after a feature or bug fix is completed and before creating a pull request.
A GitHub bot changeset-bot has been enabled that adds a comment to pull requests with changeset information from the branch and includes a warning when no changesets are found.
Contribution and feedback are encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information; see our Contribution Guidelines.
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone. By participating in this project, you agree to abide by its Code of Conduct at all times.
Copyright 2023 SAP SE or an SAP affiliate company and knowledge-hub-extension contributors. Please see our LICENSE for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available via the REUSE tool.
The Knowledge Hub extension by SAP will be available for download via the VS Code Marketplace. It will also be available for download for SAP Business Application Studio.
This project is open to feature requests/suggestions, bug reports etc. via GitHub issues.