SDK Modernization #585
Merged
SDK Modernization #585
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add 'prepare' script instead of lib/ folder
Fix GHAs to match build scripts
paulbellamy
approved these changes
Apr 13, 2023
Shaptic
added a commit
that referenced
this pull request
May 8, 2023
* SDK Modernization (#585) # Building Webpack 5 support is here! - the node package is built using Babel via `yarn build:node` - the browser bundle is built using Webpack via `yarn build:browser` * this is configured in `cfg/webpack.config.browser.js` * its accessible after including the script via the `StellarBase` variable * it adds a handful of important polyfills * it does linting via ESLint # Linting ESLint, Prettier, and DTSLint are all updated: - ESLint works with Babel via the `@babel/eslint-parser` in each `.eslintrc.js` file and is implicitly part of building via Webpack (see above) - DTSLint is part of the `@definitelytyped` project and has additional configuration implicitly as part of the `types/.eslintrc.js` file which uses `@typescript-eslint/parser`, instead - Prettier is configured in `cfg/prettier.config.js` (and `cfg/.prettierignore`) and runs on all files now. It's also (still) a pre-commit hook. Just run `yarn pretty && yarn lint` to format your files and check that everything is up to par. # Testing **Istanbul**: Istanbul is [unmaintained](https://www.npmjs.com/package/istanbul) and superceded by the `nyc` package. - the `istanbul` plugin in `.babelrc` tells Babel about it - `cfg/.nycrc` extends a Babel-compatible configuration file ([docs](https://github.com/istanbuljs/nyc#babel-projects)) - the `nyc` key in `package.json` configures instrumentation behavior - the coverage is *actually* provided by `babel-plugin-istanbul` ([docs](https://github.com/istanbuljs/babel-plugin-istanbul)), which is why `"instrument": false` in the above **Node Testing**: Mocha (and its helper friends Sinon and Chai) has been updated. - the `mocha` key in `package.json` configures Mocha (replacing `mocha.opts`) - this does Babel transpiling and hooks in the helper script - code coverage is provided by `nyc` (see above) **Browser Testing**: Karma has been updated. - the SauceLabs Karma configuration has been removed entirely because it wasn't being used - Karma has been updated with a code coverage integration with `nyc` ([docs](https://github.com/istanbuljs/babel-plugin-istanbul#karma), see above) - It relies on the Webpack configuration but makes some minor changes Run `yarn test` to run both suites. # Scripts Development has a slightly different workflow now: - build+test locally with `yarn test:node` - this will only run node tests (which are faster/simpler) - you can `yarn build && yarn test:all` to get the both test suites (note that building first is *required*) - run `yarn preversion` when you want a thorough, clean test of the whole system in "production" mode * Update generated XDR to latest version. (#587)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Same as #584, but to
master, because I'm bad at reading comprehension and merged intosorobanfirst.