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

feat: add typescript #42

Merged
merged 1 commit into from
Oct 9, 2024
Merged

feat: add typescript #42

merged 1 commit into from
Oct 9, 2024

Conversation

raphaelbs
Copy link
Collaborator

@raphaelbs raphaelbs commented Oct 7, 2024

Note - Since this is a public repository, make sure that we're not publishing private data in the code, commit comments, or this PR.

Note for reviewers - Please add a 2nd reviewer if the PR affects more than 15 files or 100 lines (not counting
package-lock.json), if it incurs significant risk, or if it is going through a 2nd review+fix cycle.

📚 Context/Description Behind The Change

  • Convert this repository to Typescript.
  • Adds Github actions to auto-release via semantic release Dropped. It is going to be done later.

🚨 Potential Risks & What To Monitor After Deployment

The following syntaxes is not going to be supported anymore:

// ❌ Fail
import { parse } from 'search-string';
// 🟢 Replace with
import SearchString from 'search-string';
// and them
SearchString.parse()

// ❌ Fail
const SearchString = require('search-string');
// 🟢 Replace with
const SearchString = require('search-string').default;

🧑‍🔬 How Has This Been Tested?

  • Unit tests working without behavior change
  • TS build
  • Simulate NPM publishing with npm pack. Copy-pasted the generated files to another projects that uses this and asserted that it builds fine.

🚚 Release Plan

Merge, manually release to NPM under a new major version

@raphaelbs raphaelbs requested review from a team and laszlovaspal and removed request for a team October 7, 2024 21:33
Copy link

@laszlovaspal laszlovaspal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

package.json Outdated Show resolved Hide resolved
@raphaelbs raphaelbs force-pushed the raphaelbs/COMM-2678 branch 2 times, most recently from 4f27d6d to 0c7fc13 Compare October 8, 2024 18:30
@raphaelbs raphaelbs changed the title feat: add typescript and continuous integration feat: add typescript Oct 8, 2024
@raphaelbs raphaelbs merged commit 163ccbd into master Oct 9, 2024
3 checks passed
@raphaelbs raphaelbs deleted the raphaelbs/COMM-2678 branch October 9, 2024 00:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants