Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

auro-badge: add tsconfig support #39

Closed
blackfalcon opened this issue Mar 21, 2023 · 2 comments
Closed

auro-badge: add tsconfig support #39

blackfalcon opened this issue Mar 21, 2023 · 2 comments
Assignees
Labels

Comments

@blackfalcon
Copy link
Member

Is your feature request related to a problem? Please describe.

The element does not support typescript users.

Describe the solution you'd like

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
  }
}

Describe alternatives you've considered

A clear and concise description of any alternative solutions or features you've considered.

Additional context

Add any other context or screenshots about the feature request here.

@blackfalcon blackfalcon added this to the Badge: Node 18+ support milestone Mar 21, 2023
@blackfalcon blackfalcon self-assigned this Mar 22, 2023
blackfalcon added a commit that referenced this issue Apr 6, 2023
Changes to be committed:
modified:   package-lock.json
modified:   package.json
new file:   tsconfig.json
@blackfalcon blackfalcon mentioned this issue Apr 6, 2023
6 tasks
blackfalcon added a commit that referenced this issue Apr 6, 2023
Changes to be committed:
modified:   package-lock.json
modified:   package.json
new file:   tsconfig.json
blackfalcon added a commit that referenced this issue Apr 7, 2023
Changes to be committed:
modified:   package-lock.json
modified:   package.json
new file:   tsconfig.json
blackfalcon added a commit that referenced this issue Apr 9, 2023
Changes to be committed:
modified:   package-lock.json
modified:   package.json
new file:   tsconfig.json
@blackfalcon
Copy link
Member Author

/duplicate

blackfalcon added a commit that referenced this issue Apr 13, 2023
Changes to be committed:
modified:   package-lock.json
modified:   package.json
new file:   tsconfig.json
@settings settings bot removed the auro-badge label Apr 13, 2023
blackfalcon pushed a commit that referenced this issue Apr 13, 2023
# [2.0.0](v1.2.4...v2.0.0) (2023-04-13)

### Documentation

* **npm:** update npm namespace [#37](#37) ([ebe7baa](ebe7baa))

### Features

* **ts:** add support for typescript users [#39](#39) ([6d960f0](6d960f0))

### Performance Improvements

* **demo styles:** remove local dependency [#34](#34) ([8d3dc13](8d3dc13))
* **es5:** remove legacy bundle build process [#35](#35) ([5166da4](5166da4))
* **extend:** move customElements.define function to root [#44](#44) ([44ad8c8](44ad8c8))
* **husky:** update to current version [#43](#43) ([f14f563](f14f563))
* **lit:** update component to Lit2.0 [#32](#32) ([2dbf150](2dbf150))
* **node18:** update repo to support Node 18+ [#31](#31) ([8617c36](8617c36))
* **postCss:** remove legacy build services [#40](#40) ([651fcb7](651fcb7))
* **sass:** update to dart-sass [#42](#42) ([d8f40ff](d8f40ff))
* **server:** update to use single shell [#33](#33) ([181aba8](181aba8))

### BREAKING CHANGES

* **npm:** This update will redefine the npm namespace
for the auro-badge element.

Changes to be committed:
modified:   README.md
modified:   package.json
@blackfalcon
Copy link
Member Author

/duplicate

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant