{"id":13831703,"url":"https://github.com/vscode-elements/elements","last_synced_at":"2025-04-08T10:22:24.797Z","repository":{"id":35801932,"uuid":"210041959","full_name":"vscode-elements/elements","owner":"vscode-elements","description":"Web component library for developing Visual Studio Code extensions","archived":false,"fork":false,"pushed_at":"2024-10-29T19:22:49.000Z","size":6826,"stargazers_count":138,"open_issues_count":20,"forks_count":26,"subscribers_count":5,"default_branch":"main","last_synced_at":"2024-10-29T21:34:37.336Z","etag":null,"topics":["lit","lit-element","lit-html","typescript","visual-studio-code","vscode","vscode-webview","webcomponents"],"latest_commit_sha":null,"homepage":"https://vscode-elements.github.io","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vscode-elements.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-09-21T19:26:02.000Z","updated_at":"2024-10-29T07:39:42.000Z","dependencies_parsed_at":"2023-11-12T00:23:08.750Z","dependency_job_id":"542bdbaf-a8f5-4d72-be99-29cde2f45db8","html_url":"https://github.com/vscode-elements/elements","commit_stats":{"total_commits":1261,"total_committers":10,"mean_commits":126.1,"dds":0.07216494845360821,"last_synced_commit":"3ccac718bea424411c1f9e3194d3553934f0d837"},"previous_names":[],"tags_count":93,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vscode-elements%2Felements","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vscode-elements%2Felements/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vscode-elements%2Felements/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vscode-elements%2Felements/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vscode-elements","download_url":"https://codeload.github.com/vscode-elements/elements/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247820017,"owners_count":21001418,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["lit","lit-element","lit-html","typescript","visual-studio-code","vscode","vscode-webview","webcomponents"],"created_at":"2024-08-04T10:01:37.884Z","updated_at":"2025-04-08T10:22:24.773Z","avatar_url":"https://github.com/vscode-elements.png","language":"HTML","funding_links":[],"categories":["HTML"],"sub_categories":[],"readme":"# VSCode Elements\n\nFor the end-user documentation, [click here](https://vscode-elements.github.io).\n\nThis documentation is intended for developers who would like to contribute to or modify the code on their own.\n\nVSCode Elements is based on the [Lit](https://lit.dev/) library. The local development environment requires `NodeJS 22` or newer. If you want to use a local copy of the library in your codebase, you can use the `npm link` command. First, navigate to the VSCode Elements directory and run:\n\n```bash\nnpm link\n```\n\nThen, go to the library where you want to use it and run:\n\n```bash\nnpm link @vscode-elements/elements\n```\n\n\u003e [!WARNING]\n\u003e\n\u003e Multiple packages must be linked with a single command. For example:\n\u003e\n\u003e ```bash\n\u003e npm link @vscode-elements/elements @vscode-elements/webview-playground\n\u003e ```\n\nDon't forget to run the build script before using the package.\n\n## Setup\n\nInstall dependencies:\n\n```bash\nnpm ci\n```\n\n## The scripts defined in `package.json`\n\nEach script can be run using the `npm run \u003cscript_name\u003e` format. Wireit is used to cache the script\nresults.\n\n### build\n\nBuild everything. This command generates all the files that will be included in the package. These include:\n\n- Transpiled JavaScript files with type definitions and source maps.\n- The custom elements manifest file.\n- VSCode custom data files.\n- The entire library as a single, minified JavaScript file.\n\n### built:ts\n\nTranspiles TypeScript files into standard ES6 JavaScript, without minification. These files can then be imported and optimized in the end-user application.\n\n### build:watch\n\nSame as the above, but the TypeScript compiler run in watch mode and recompile the modified files\nautomatically.\n\n### clean\n\nRemoves the generated files.\n\n### lint\n\nCode style check with [ESLint](https://eslint.org/).\n\n### lint:fix\n\nAutomatically fixing code style issues.\n\n### prettier\n\nChecks code formatting with [Prettier](https://prettier.io/).\n\n### prettier:fix\n\nAutomatically fixing code format issues.\n\n### analyze\n\nGenerates a [custom elements manifest file](https://custom-elements-manifest.open-wc.org/). This file is shipped with the package, and it is the file on which the API view in the documentation site is based.\n\n### serve\n\nStart the [Web Test Runner](https://modern-web.dev/docs/test-runner/overview/) development server.\n\n### start\n\nStart the development server and the TypeScript compiler in watch mode, then opens the default\nbrowser. This is the most used command during the development.\n\n### test\n\nCompiles the test files and runs them. Because tests are written in TypeScript, a transpilation step\nis also needed.\n\n### test:coverage\n\nSame as above, but it also generates coverage.\n\n### test:watch\n\nWatches the transpiled test files and runs them if any changes are detected. This script does not compile the test files; the `build:watch` script needs to be run in a separate terminal. However, it can also be run in parallel with the `start` script instead of build:watch.\n\n### checksize\n\nDisplays the file size of the bundled library (dist/bundled.js) in bytes.\n\n### icons\n\nGenerates icon list for the documentation site\n\n### vscode-data\n\nGenerates HTML and CSS [custom data format](https://code.visualstudio.com/blogs/2020/02/24/custom-data-format) for VSCode code completions.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvscode-elements%2Felements","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvscode-elements%2Felements","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvscode-elements%2Felements/lists"}