Is your feature request related to a problem? Please describe.
The badge element is built using Lit1.0 and related dependencies. The element does not support typescript users. Issue templates and github settings in this repo are outdated. The current badge element is well behind recent versions of core support functions.
This repo does not support TS users.
This repo's issue templates are out of date.
This repo does not support component extension.
Describe the solution you'd like
Update to Lit2.0
Using a Node 18 environment, update all other dependencies. This may include deleting and rebuilding the package-lock.json file and node_modules/ directory then running npm run i to recreate all resources.
Update component registration
Update the following core features of the badge element
Remove the element definition from the element .js file and place into index.js file
Update rollup dependencies and configs to support the new import model
Update typescript support
Update the repo to support typescript. The solution is to use the typescript npm package, add a types npm build script and create a tsconfig.json file.
tsconfig.json example
{
"include": ["src/**/*.js"], // process the generated JS files from the src js files
"exclude": [],
"compilerOptions": {
// Tells TypeScript to read JS files, as
// normally they are ignored as source files
"allowJs": true,
// Generate d.ts files
"declaration": true,
// This compiler run should
// only output d.ts files
"emitDeclarationOnly": true,
"outDir": "dist",
// go to js file when using IDE functions like
// "Go to Definition" in VSCode
"declarationMap": true
}
}
Remove all npm scripts related to building a demo in a ./build dir and delete ./scripts/prepForBuild.js
Update dependencies to match package.json in the Auro Generator
Remove all references to focus-visible and @webcomponents/webcomponentsjs
Update to chalk v.5 and update all files that use chalk as a dependency
Update ./scripts/postCss.js to match the version in the Auro Generator and remove all unused dependencies from the package.json
Delete ./scripts/removeNonRemPlugin.js
Delete ./index.html
Update the README
Update the Install bundled assets from CDN section to match that of the Auro Generator templates. Remove references to any es5 module support.
Update the settings.yml
Update ./github/settings.yml to match the Auro Generator
Update Test and Publish
Update .github/workflows/testPublish.yml to match the Auro Generator
Exit criteria
This issue will be considered closed once the repo is updated to Lit2.0 and all features and tests operate as expected with all other dependencies updated as well.
This issue can be closed once a .d.ts file is created with the build.
This issue can be closed once the issue templates match the content from the generator repo.
This issue will not be considered complete once the listed core features are updated along with all associated dependencies and all features work as previously expected with node 18 installed.
Is your feature request related to a problem? Please describe.
The badge element is built using Lit1.0 and related dependencies. The element does not support typescript users. Issue templates and github settings in this repo are outdated. The current badge element is well behind recent versions of core support functions.
This repo does not support TS users.
This repo's issue templates are out of date.
This repo does not support component extension.
Describe the solution you'd like
Update to Lit2.0
Using a Node 18 environment, update all other dependencies. This may include deleting and rebuilding the
package-lock.json
file andnode_modules/
directory then runningnpm run i
to recreate all resources.Update component registration
Update the following core features of the badge element
Update typescript support
Update the repo to support typescript. The solution is to use the
typescript
npm package, add atypes
npm build script and create atsconfig.json
file.tsconfig.json example
Update the repo's ISSUE TEMPLATES
When reviewing code from the previous issue commit, be sure to include this commit as well. https://github.com/AlaskaAirlines/auro-badge/commit/fdaddcc8d314decfa891a1930ba90d31293943f2
Remvoe legacy build files and dependencies
Update the README
Update the
Install bundled assets from CDN
section to match that of the Auro Generator templates. Remove references to any es5 module support.Update the settings.yml
Update ./github/settings.yml to match the Auro Generator
Update Test and Publish
Update .github/workflows/testPublish.yml to match the Auro Generator
Exit criteria
This issue will be considered closed once the repo is updated to Lit2.0 and all features and tests operate as expected with all other dependencies updated as well.
This issue can be closed once a .d.ts file is created with the build.
This issue can be closed once the issue templates match the content from the generator repo.
This issue will not be considered complete once the listed core features are updated along with all associated dependencies and all features work as previously expected with node 18 installed.