Environment - full configuration & npm for package managing #5
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
The gitignore is taken from the official GitHub gitignore repository. The configuration used for this package is the Node.gitignore: https://github.com/github/gitignore/blob/master/Node.gitignore
It turns out that only the license expressions used from the following source: https://spdx.org/licenses/ are correct. According to that, the "GPL-3.0-or-later" has been set as the specific license for this package. NOTE: This issue has been found due to npm used in this repo.
The ESLint configuration is done for JavaScript files only and on the recommended options and configuration. Even though all non-checked files are marked as ignored in the .eslintignore file, still the main check should be launched for the main source directory: .\src\**
The CI workflow is divided into three main jobs: * install installs all the dependencies and caches the output (currently the node_modules directory) * verify runs the ESLint on the sources to verify the standard kept during the development and the corrections of the code * build (to be implemented) This steps builds the package and puts it to the artiffacts, ready to be published.
Two errors had to be fixed before delivery: `e` variable unused `browser` undefined - this error had to be fixed by setting the "browser" variable as global for ESLint, due to the fact that in Mozilla extensions the `browser` is a built in variable and it won't be recognized as a defined var.
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.
This pull request adds the full support and full scope of configuration for the package repository.
This contains all the configuration and managing of the npm based package. Everything required for further development is delivered within this PR.
Whole repository and sources were wrapped in the npm based package with the proper package.json and repository information.
New features, tools and configurations done in this implementation are:
The npm tool is used to manage and handle all the developer dependencies, node modules and tools used during the development
The configuration is done using the recommended configuration, but it has been extended with the
globalsto avoid errors when checking the built-in variables (specific for browser extension development).The build and deployment step is not yet implemented, but the tools and environment were decided to be added so that further enhancements will be smoother.
The CI workflow contains three steps:
install,verifyandbuild. For more details please check the commit messages.It's a common habit to name the npm based packages with the lower-case names separated with dash
-.Note that the name of the extension is left as it was: "KeepYourSession" but this perhaps will be further reconsidered.
For more information about each change please check the commit messages.