sap/code-snippet

A VSCode extension that provides a simple way to add code snippets.

Code Snippet Framework

The VSCode Code Snippet framework enables extension developers to display a GUI form to end users and generate or edit source code snippets based on the end user's answers to those questions.

Description

This is the npm mono-repo for the VSCode Code Snippet framework

It currently contains the following packages:

• code-snippet The VSCode extension part of Code Snippet framework.
• code-snippet-frontend the user interface part of the Code Snippet framework.
• vscode-snippet-contrib A sample VSCode extension utilizing the Code Snippet framework.
• @sap-devx/code-snippet-types TypeScript type definitions to assist in using the Code Snippet framework.

How to obtain support

To get more help, support, and information please open a github issue.

Contributing

Contributing information can be found in the CONTRIBUTING.md file.

code-snippet's Issues

When validation on a questions fails the error below the question is not red

Auth Tokens (NPM/github) should belong to a service account.

CircleCI build node versions updating

• Remove node10 (after 30/4)
• Add node16 (should already be out)

Dependabot couldn't find a package.json for this project

Dependabot couldn't find a package.json for this project.

Dependabot requires a package.json to evaluate your project's current JavaScript dependencies. It had expected to find one at the path: /backend/package.json.

If this isn't a JavaScript project, or if it is a library, you may wish to disable updates for it from within Dependabot.

View the update logs.

The API of plugins is not defined.

Specifically this means the API of the object that needs to be returned from a plugin VSCode extension's activate() method.

These should be defined as part of the code-snippet-types package.

Evaluate duplicating/extracting the internal "cookbook" docs here.

Launch Configurations created by the example are invalid

Local Dev mode lacks documentation

• In root CONTRIBUTING.md
• The process should leverage the mono-repo and lerna, preferably there would only be a single root entry script / point for this flow.

coveralls integration is currently disabled

https://github.com/SAP/code-snippet/blob/master/.circleci/config.yml#L20-L26

re-enable dependabot (non-preview version)

Types sub-package should use d.ts not .ts files

https://github.com/SAP/code-snippet/blob/master/types/src/Snippet.ts

Basically there is no need to compile pure signatures as they disappear during compliation
as TypeScript is a design time only tool.

See examples:

• https://github.com/SAP/ui5-language-assistant/tree/master/packages/semantic-model-types
• https://github.com/SAP/vscode-logging/tree/master/packages/types

Local Dev Mode throws exception

$ node ./out/src/webSocketServer/index.js
internal/modules/cjs/loader.js:883
  throw err;
  ^

Error: Cannot find module './../../package.json'
Require stack:
- C:\SAPDevelop\workspace\code-snippet\packages\backend\out\src\swa-tracker\swa-tracker-wrapper.js
- C:\SAPDevelop\workspace\code-snippet\packages\backend\out\src\code-snippet.js
- C:\SAPDevelop\workspace\code-snippet\packages\backend\out\src\webSocketServer\index.js
    at Function.Module._resolveFilename (internal/modules/cjs/loader.js:880:15)
    at Function.Module._load (internal/modules/cjs/loader.js:725:27)
    at Module.require (internal/modules/cjs/loader.js:952:19)
    at require (internal/modules/cjs/helpers.js:88:18)
    at Object.<anonymous> (C:\SAPDevelop\workspace\code-snippet\packages\backend\out\src\swa-tracker\swa-tracker-wrapper.js:7:21)
    at Module._compile (internal/modules/cjs/loader.js:1063:30)
    at Object.Module._extensions..js (internal/modules/cjs/loader.js:1092:10)
    at Module.load (internal/modules/cjs/loader.js:928:32)
    at Function.Module._load (internal/modules/cjs/loader.js:769:14)
    at Module.require (internal/modules/cjs/loader.js:952:19) {
  code: 'MODULE_NOT_FOUND',
  requireStack: [
    'C:\\SAPDevelop\\workspace\\code-snippet\\packages\\backend\\out\\src\\swa-tracker\\swa-tracker-wrapper.js',
    'C:\\SAPDevelop\\workspace\\code-snippet\\packages\\backend\\out\\src\\code-snippet.js',
    'C:\\SAPDevelop\\workspace\\code-snippet\\packages\\backend\\out\\src\\webSocketServer\\index.js'
  ]
}
error Command failed with exit code 1.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.

Dependabot couldn't find a package.json for this project

Dependabot couldn't find a package.json for this project.

Dependabot requires a package.json to evaluate your project's current JavaScript dependencies. It had expected to find one at the path: /backend/package.json.

If this isn't a JavaScript project, or if it is a library, you may wish to disable updates for it from within Dependabot.

View the update logs.

The label of question is wrapped even if it takes less than half the panel‘s width

In many scenarios, even there is still a lot of space available in the panel, the label of question is displayed in multiple lines. It is unexpected that the label's maximum width is only 35%.