diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..dc79395 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,15 @@ + + +### Expected Behaviour + +### Actual Behaviour + +### Reproduce Scenario (including but not limited to) + +#### Steps to Reproduce + +#### Platform and Version + +#### Sample Code that illustrates the problem + +#### Logs taken while reproducing problem diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..856226c --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,36 @@ + + +## Description + + + +## Related Issue + + + + +Fixes # + +## Types of changes + + + +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to change) + +## Checklist: + + + +- [ ] My code follows the code style of this project. +- [ ] I have read the **[CONTRIBUTING](docs/CONTRIBUTING.mnd)** document. +- [ ] All new and existing tests passed. diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..e45ee52 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,31 @@ +name: CI + +on: + push: + branches: [ '**' ] + pull_request: + branches: [ $default-branch ] + +jobs: + build: + + runs-on: ${{ matrix.os }} + + strategy: + matrix: + os: [ubuntu-latest] + node-version: [16.x] + + steps: + - name: Checkout + uses: actions/checkout@v3 + - name: Setup Node.js ${{ matrix.node-version }} + uses: actions/setup-node@v1 + with: + node-version: ${{ matrix.node-version }} + - name: Install dependencies + run: npm ci + - name: Build Library + run: npm run build --if-present + - name: Run Tests + run: npm test --if-present diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml new file mode 100644 index 0000000..e275821 --- /dev/null +++ b/.github/workflows/codeql-analysis.yml @@ -0,0 +1,45 @@ +# For most projects, this workflow file will not need changing; you simply need +# to commit it to your repository. +# +# You may wish to alter this file to override the set of languages analyzed, +# or to provide custom queries or build logic. +# +# ******** NOTE ******** +# We have attempted to detect the languages in your repository. Please check +# the `language` matrix defined below to confirm you have the correct set of +# supported CodeQL languages. +# +name: "CodeQL" + +on: + push: + branches: [ main ] + pull_request: + # The branches below must be a subset of the branches above + branches: [ main ] + schedule: + - cron: '20 12 * * 0' + +jobs: + analyze: + name: Analyze + runs-on: ubuntu-latest + + strategy: + fail-fast: false + matrix: + language: [ 'javascript' ] + steps: + - name: Checkout + uses: actions/checkout@v2 + + # Initializes the CodeQL tools for scanning. + - name: Initialize CodeQL + uses: github/codeql-action/init@v1 + with: + languages: ${{ matrix.language }} + + - run: npm run build --if-present + + - name: Perform CodeQL Analysis + uses: github/codeql-action/analyze@v1 diff --git a/.github/workflows/manual-release.yml b/.github/workflows/manual-release.yml new file mode 100644 index 0000000..5f6da5a --- /dev/null +++ b/.github/workflows/manual-release.yml @@ -0,0 +1,73 @@ +name: Manual Release +on: + workflow_dispatch: + inputs: + version: + description: 'Version' + type: choice + required: true + default: patch + options: + - patch + - minor + - major + dryRun: + description: 'DryRun' + type: boolean + default: true +# ENV and Config +env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + NPM_TOKEN: ${{ secrets.NPM_TOKEN }} + GIT_AUTHOR_NAME: github-actions + GIT_AUTHOR_EMAIL: github-actions@github.com + GIT_COMMITTER_NAME: github-actions + GIT_COMMITTER_EMAIL: github-actions@github.com + CI: true + CONFIG_NODE_VERSION: '["16.x"]' + CONFIG_OS: '["ubuntu-latest"]' +# Main Job +jobs: + config: + runs-on: ubuntu-latest + outputs: + NODE_VERSION: ${{ steps.set-config.outputs.CONFIG_NODE_VERSION }} + OS: ${{ steps.set-config.outputs.CONFIG_OS }} + steps: + - id: set-config + run: | + echo "CONFIG_NODE_VERSION=${{ toJSON(env.CONFIG_NODE_VERSION) }}" >> $GITHUB_OUTPUT + echo "CONFIG_OS=${{ toJSON(env.CONFIG_OS) }}" >> $GITHUB_OUTPUT + release: + name: Test, Build and force Release + needs: config + + runs-on: ${{ matrix.OS }} + strategy: + matrix: + OS: ${{ fromJSON(needs.config.outputs.OS) }} + NODE_VERSION: ${{ fromJSON(needs.config.outputs.NODE_VERSION) }} + + steps: + - name: Checkout repo + uses: actions/checkout@v3 + - name: Setup Node.js ${{ matrix.NODE_VERSION }} + uses: actions/setup-node@v3 + with: + node-version: ${{ matrix.NODE_VERSION }} + - name: Commit trigger + run: | + git commit --allow-empty -m "${{ github.event.inputs.version }}: Trigger Manual Release" + - name: Install dependencies + run: npm ci + - name: Build Library + run: npm run build --if-present + - name: Run Tests + run: npm test --if-present + - name: Publish npm package + uses: cycjimmy/semantic-release-action@v3 + with: + dry_run: ${{ github.event.inputs.dryRun == 'true' }} + extra_plugins: | + @semantic-release/changelog + @semantic-release/git diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100644 index 0000000..5291c5c --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,44 @@ +name: Release + +on: + push: + branches: + - main + +jobs: + release: + name: Test, Build and Release + runs-on: ${{ matrix.os }} + strategy: + matrix: + os: [ ubuntu-latest ] + node-version: [ 16.x ] + + steps: + - name: Checkout + uses: actions/checkout@v3 + - name: Setup Node.js + uses: actions/setup-node@v3 + with: + node-version: ${{ matrix['node-version'] }} + - name: Install dependencies + run: npm ci + - name: Build Library + run: npm run build --if-present + - name: Run Tests + run: npm test --if-present + - name: Release + uses: cycjimmy/semantic-release-action@v3 + with: + dry_run: true + extra_plugins: | + @semantic-release/changelog + @semantic-release/git + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + NPM_TOKEN: ${{ secrets.NPM_TOKEN }} + GIT_AUTHOR_NAME: github-actions + GIT_AUTHOR_EMAIL: github-actions@github.com + GIT_COMMITTER_NAME: github-actions + GIT_COMMITTER_EMAIL: github-actions@github.com + CI: true diff --git a/.gitignore b/.gitignore index 149d91e..eccf3f9 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,32 @@ -npm-debug.log -node_modules -package-lock.json -.npmrc \ No newline at end of file +# Logs +logs +*.log + +# IDE +.project +.classpath +.settings +.idea/ +*.iml* +*.ipr +.brackets.json +.vscode/ +.history + +# OS +.DS_Store +*.swp + +# Node related files +node_modules/ +node/ +bin/ +typings +npm-debug.log* +yarn-debug.log* +yarn-error.log* +.stylelintcache +.eslintcache + +# env +\.env diff --git a/.npmignore b/.npmignore new file mode 100644 index 0000000..2187599 --- /dev/null +++ b/.npmignore @@ -0,0 +1,20 @@ +.eslintrc +.nyc_output +rollup.config.js +.prettierrc +.git +.prettierignore +**/.git/ +**/node_modules/ +yarn.lock +/dev +/docs +/public +/coverage +/.vscode +/tests +/temp +/templates +/demos +/src +.github diff --git a/.releaserc b/.releaserc new file mode 100644 index 0000000..7c78d4c --- /dev/null +++ b/.releaserc @@ -0,0 +1,20 @@ +{ + "branches": ["main"], + "plugins": [ + "@semantic-release/commit-analyzer", + "@semantic-release/release-notes-generator", + [ + "@semantic-release/changelog", + { + "changelogFile": "docs/CHANGELOG.md" + } + ], + "@semantic-release/npm", + [ + "@semantic-release/git", + { + "assets": ["docs/CHANGELOG.md", "package.json"] + } + ] + ] +} \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..a0d69d7 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2023 Cognizant Netcentric + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md index d16b900..fdf972e 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,12 @@ -# Component loader +# @netcentric/component-loader + +Description + +[![Version](https://img.shields.io/npm/v/@netcentric/component-loader.svg)](https://npmjs.org/package/@netcentric/component-loader) +[![Build Status](https://github.com/netcentric/component-loader/workflows/CI/badge.svg?branch=main)](https://github.com/netcentric/component-loader/actions) +[![CodeQL Analysis](https://github.com/netcentric/component-loader/workflows/CodeQL/badge.svg?branch=main)](https://github.com/netcentric/component-loader/actions) +[![semver: semantic-release](https://img.shields.io/badge/semver-semantic--release-blue.svg)](https://github.com/semantic-release/semantic-release) +[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) ## Table of Changes @@ -14,14 +22,9 @@ | Iteration over nodes instead of components | Nodes define with components to init | -# how to use it on your project - - ### Installation -1 - Make sure you have your `.npmrc` file setup (see ["How can I install an NPM-NC package globally for my local user's account?"](https://projects.netcentric.biz/wiki/display/FRONTEND/Netcentric%27s+NPM+Repository+-+NPM-NC) ) - -2 - Run ```npm install --save @nc/component-loader``` +```npm install @netcentric/component-loader``` #### important! babel @@ -33,7 +36,7 @@ Eg: // webpack babel-loader config module.exports = { test: /\.js$/, - exclude: /node_modules\/(?!@nc)/, + exclude: /node_modules\/(?!@netcentric)/, loader: 'babel-loader', options: { presets: '@babel/preset-env' @@ -41,7 +44,7 @@ module.exports = { }; ``` -Here we are excluding node_modules, except the ones under node_modules/@nc/* +Here we are excluding node_modules, except the ones under node_modules/@netcentric/* ### Usage @@ -69,7 +72,7 @@ run(); #### at the component `.entry.` file you should register your component ```javascript -import { register } from '@nc/component-loader'; +import { register } from '@netcentric/component-loader'; import { text } from './text.component'; // register your component to be loaded @@ -84,7 +87,7 @@ register({ text }); import { observe, run -} from '@nc/component-loader'; +} from '@netcentric/component-loader'; // Run all registered component - used usually with http1 run(); @@ -136,7 +139,7 @@ You can register individual component, or list ```javascript -import { register } from '@nc/component-loader'; +import { register } from '@netcentric/component-loader'; import { title } from 'components/title'; import { text } from 'components/text'; @@ -148,7 +151,7 @@ Or you can register several components based on proper named exports ```javascript -import { register } from '@nc/component-loader'; +import { register } from '@netcentric/component-loader'; import * as components from 'components'; // register all components exported as proper named exports on components/index.js @@ -157,13 +160,13 @@ register({ components }); ``` -Level is used in multilevel inheritance, eg if you have one base project with component HTML, +Level is used in multilevel inheritance, eg if you have one base project with component HTML, and want to override just JS part in sub project 1. Base project ```javascript -import { register } from '@nc/component-loader'; +import { register } from '@netcentric/component-loader'; class Title { init() { @@ -177,7 +180,7 @@ register({ Title }, 0); 2. Sub project ```javascript -import { register, components } from '@nc/component-loader'; +import { register, components } from '@netcentric/component-loader'; class Title extends components[0].Title { init() { @@ -210,7 +213,7 @@ This will run the loader on previously registered components. import { register, run -} from '@nc/component-loader'; +} from '@netcentric/component-loader'; // eg components import { title } from 'components/title'; @@ -235,20 +238,20 @@ If you want to access all components constructors you can just import it in any ```javascript -import { components } from '@nc/component-loader'; +import { components } from '@netcentric/component-loader'; ``` ### instances This object will store all instances of components separated by [className][instanceId]. -We store it on its own file so it can be imported into separated files and without having to import the other components logic. +We store it on its own file, so it can be imported into separated files and without having to import the other components logic. If you want to access all the instances of components you can just import it in any file like: ```javascript -import { instances } from '@nc/component-loader'; +import { instances } from '@netcentric/component-loader'; const howManyTitles = instances.title.length; @@ -257,3 +260,46 @@ const getTitleByUUID = (uuid) => instances.title.filter(instance => instance.el. const mytitle = getTitleByUUID('a8c405b5-1928-46ed-afa1-5a0a3f4dde6c'); ``` + +### Docs +- LICENSE +- docs/CODE_OF_CONDUCT.md +- docs/CONTRIBUTING.md +- docs/CHANGELOG.md --> dynamically updated + +### Issue template +- .github/ISSUE_TEMPLATE.md + +### PR template +- .github/PULL_REQUEST_TEMPLATE.md --> automatically closes connected issue + +### Workflows +- CI --> npm ci, test and build +- CodeQL --> Perform CodeQL Analysis (Security, etc.) +- Release --> semantic-release: + * Creates release notes + * Updates CHANGELOG + * Updates package.json version + * Creates Git tag/release + * Publish package to NPM +- Manual Release --> same as Release, but can be triggered manually in Actions tab + +### Release +- based on Angular Commit Message Conventions in commits - + https://github.com/angular/angular/blob/master/CONTRIBUTING.md#commit-message-header +- Commit message format is used to build: + * Release notes + * Changelog updates + * NPM package semver + +### Commit message Convention + +``` +(): +│ │ │ +│ │ └─⫸ Summary in present tense. Not capitalized. No period at the end. +│ │ +│ └─⫸ Commit Scope (optional): project|based|list +│ +└─⫸ Commit Type: build|ci|docs|feat|fix|perf|refactor|test +``` diff --git a/CHANGELOG.md b/docs/CHANGELOG.md similarity index 77% rename from CHANGELOG.md rename to docs/CHANGELOG.md index 8125e2b..3dd8bbe 100644 --- a/CHANGELOG.md +++ b/docs/CHANGELOG.md @@ -2,14 +2,13 @@ ## Unreleased - ### v.0.1.11 (HECORE-48) - add multilevel support for same name components - fix runComponent selector ### v.0.1.10 (NPMNC-98) -- Same API kept -- Split functionalities to be used stand alone +- Same API kept +- Split functionalities to be used stand alone - runComponent (splitted) for running one component scan and initialisation - scan (splitted) for scanning the DOM - factory (splitted) for actually factoring the components @@ -22,8 +21,8 @@ ## [0.1.4] - 2018-10-05 ### Added - Async problem when node_modules is transpiled error is: -`Uncaught ReferenceError: regeneratorRuntime is not defined` -Solution was add some very expensive babel polyfills, return to timeout + `Uncaught ReferenceError: regeneratorRuntime is not defined` + Solution was add some very expensive babel polyfills, return to timeout ## [0.1.3] - 2018-10-05 ### Added diff --git a/docs/CODE_OF_CONDUCT.md b/docs/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..bae1ec9 --- /dev/null +++ b/docs/CODE_OF_CONDUCT.md @@ -0,0 +1,74 @@ +# Cognizant Netcentric Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, gender identity and expression, level of experience, +nationality, personal appearance, race, religion, or sexual identity and +orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or +advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team at Grp-opensourceoffice@adobe.com. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at [http://contributor-covenant.org/version/1/4][version] + +[homepage]: https://contributor-covenant.org +[version]: https://contributor-covenant.org/version/1/4/ diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md new file mode 100644 index 0000000..1a20de3 --- /dev/null +++ b/docs/CONTRIBUTING.md @@ -0,0 +1,25 @@ +# Contributing + +Thanks for choosing to contribute! + +The following are a set of guidelines to follow when contributing to this project. + +## Code Of Conduct + +This project adheres to the Cognizant Netcentric [code of conduct](CODE_OF_CONDUCT.md). By participating, +you are expected to uphold this code. + +## Have A Question? + +Start by filing an issue. The existing committers on this project work to reach +consensus around project direction and issue solutions within issue threads +(when appropriate). + +## Code Reviews + +All submissions should come in the form of pull requests and need to be reviewed +by project committers. Read [GitHub's pull request documentation](https://help.github.com/articles/about-pull-requests/) +for more information on sending pull requests. + +Lastly, please follow the [pull request template](../.github/PULL_REQUEST_TEMPLATE.md) when +submitting a pull request! diff --git a/package.json b/package.json index 2d49c6c..df5dbef 100644 --- a/package.json +++ b/package.json @@ -1,14 +1,19 @@ { - "name": "@nc/component-loader", - "version": "0.2.8", - "description": "This is our standard to load simple components for plain javascript projects ", - "main": "./lib/index.js", - "scripts": { - "test": "eslint ./lib" + "name": "@netcentric/component-loader", + "version": "1.0.0", + "description": "Load components for plain javascript projects", + "license": "Apache-2.0", + "private": false, + "publishConfig": { + "access": "public" }, "repository": { "type": "git", - "url": "ssh://git@source.int.netcentric.biz:7999/npm-nc/component-loader.git" + "url": "https://github.com/netcentric/component-loader" + }, + "main": "./src/index.js", + "scripts": { + "test": "eslint ./src" }, "keywords": [ "Component", @@ -22,7 +27,6 @@ "Android >= 5" ], "author": "Netcentric", - "license": "ISC", "devDependencies": { "eslint-config-airbnb-base": "^13.1.0", "eslint": "^6.7.2", diff --git a/lib/components.js b/src/components.js similarity index 100% rename from lib/components.js rename to src/components.js diff --git a/lib/create.js b/src/create.js similarity index 100% rename from lib/create.js rename to src/create.js diff --git a/lib/deferredComponents.js b/src/deferredComponents.js similarity index 100% rename from lib/deferredComponents.js rename to src/deferredComponents.js diff --git a/lib/destroy.js b/src/destroy.js similarity index 100% rename from lib/destroy.js rename to src/destroy.js diff --git a/lib/domReady.js b/src/domReady.js similarity index 100% rename from lib/domReady.js rename to src/domReady.js diff --git a/lib/factory.js b/src/factory.js similarity index 100% rename from lib/factory.js rename to src/factory.js diff --git a/lib/index.js b/src/index.js similarity index 100% rename from lib/index.js rename to src/index.js diff --git a/lib/instances.js b/src/instances.js similarity index 100% rename from lib/instances.js rename to src/instances.js diff --git a/lib/observe.js b/src/observe.js similarity index 100% rename from lib/observe.js rename to src/observe.js diff --git a/lib/register.js b/src/register.js similarity index 100% rename from lib/register.js rename to src/register.js diff --git a/lib/run.js b/src/run.js similarity index 100% rename from lib/run.js rename to src/run.js diff --git a/lib/runComponent.js b/src/runComponent.js similarity index 100% rename from lib/runComponent.js rename to src/runComponent.js diff --git a/lib/scan.js b/src/scan.js similarity index 100% rename from lib/scan.js rename to src/scan.js diff --git a/lib/uuid.js b/src/uuid.js similarity index 100% rename from lib/uuid.js rename to src/uuid.js