-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
162 additions
and
5 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,74 @@ | ||
# Adobe 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]: http://contributor-covenant.org | ||
[version]: http://contributor-covenant.org/version/1/4/ |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
# 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 Adobe [code of conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to Grp-opensourceoffice@adobe.com. | ||
|
||
## Contributor License Agreement | ||
|
||
All third-party contributions to this project must be accompanied by a signed contributor license. This gives Adobe permission to redistribute your contributions as part of the project. Sign our [CLA](http://opensource.adobe.com/cla.html). You only need to submit an Adobe CLA one time, so if you have submitted one previously, you are probably good to go! | ||
|
||
## 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. |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
Copyright 2018 Adobe | ||
|
||
Adobe holds the copyright for all the files found in this repository. | ||
|
||
See the LICENSE file for licensing information. |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,18 +1,79 @@ | ||
# @adobe/reactor-validator | ||
# Launch Extension Validator | ||
|
||
[![npm (scoped)](https://img.shields.io/npm/v/@adobe/reactor-validator.svg?style=flat)](https://www.npmjs.com/package/@adobe/reactor-validator) | ||
|
||
Validates a Launch extension package. | ||
Launch, by Adobe, is a next-generation tag management solution enabling simplified deployment of marketing technologies. For more information regarding Launch, please visit our [product website](http://www.adobe.com/enterprise/cloud-platform/launch.html). | ||
|
||
For more information regarding Launch, please visit our [product website](http://www.adobe.com/enterprise/cloud-platform/launch.html). | ||
The extension validator helps extension developers validate that an extension package is well-structured. Namely, it verifies that: | ||
|
||
1. The extension has a [manifest](https://developer.adobelaunch.com/guides/extensions/extension-manifest/) (`extension.json`) matching the expected structure. | ||
2. All referenced directories and files exist at the specified locations within the extension directory. | ||
|
||
For more information about developing an extension for Launch, please visit our [extension development guide](https://developer.adobelaunch.com/guides/extensions/). | ||
|
||
## Usage | ||
|
||
```javascript | ||
import validate from '@adobe/reactor-validator'; | ||
This tool is currently integrated and automatically executed within other tools that extension developers typically use, namely the [Launch Extension Sandbox](https://github.com/Adobe-Marketing-Cloud/reactor-sandbox) and [Launch Extension Packager](https://github.com/Adobe-Marketing-Cloud/reactor-packager). This is likely sufficient for most extension developers. | ||
|
||
### Running the Validator from the Command Line | ||
|
||
Before running the validator, you must first have [Node.js](https://nodejs.org/en/) installed on your computer. Your npm version (npm comes bundled with Node.js) will need to be at least 5.2.0. You can check the installed version by running the following command from a command line: | ||
|
||
``` | ||
npm -v | ||
``` | ||
|
||
Once Node.js is installed, run the validator by executing the following command from the command line within your extension's directory: | ||
|
||
``` | ||
npx @adobe/reactor-validator | ||
``` | ||
|
||
|
||
### Incorporating the Validator into Other Tools | ||
|
||
|
||
If you would like to incorporate the validator into your own extension development tools, you may do so by first installing the validator as a dependency inside your tool's project: | ||
|
||
``` | ||
npm i @adobe/reactor-validator | ||
``` | ||
|
||
Once it has been installed as a dependency, import the validator and pass it an extension manifest object (this is the object exported from an `extension.json` file). If the value returned from the validator is `undefined`, then the extension appears to be well-formed; otherwise, the value will contain a description of the issue that was encountered. | ||
|
||
```javascript | ||
const validate = require('@adobe/reactor-validator'); | ||
const error = validate(require('./extension.json')); | ||
|
||
// Will be undefined if no error was found. | ||
console.log(error); | ||
``` | ||
|
||
## Contributing | ||
|
||
Contributions are welcomed! Read the [Contributing Guide](CONTRIBUTING.md) for more information. | ||
|
||
To get started: | ||
|
||
1. Install [node.js](https://nodejs.org/). | ||
3. Clone the repository. | ||
4. After navigating into the project directory, install project dependencies by running `npm install`. | ||
|
||
To manually test your changes, first run the following command from the sandbox tool directory: | ||
|
||
``` | ||
npm link | ||
``` | ||
|
||
Then, in a directory containing an extension (any extension you would like to use for testing), run the following command: | ||
|
||
``` | ||
npx @adobe/reactor-validator | ||
``` | ||
|
||
Npx will execute the sandbox tool using your locally linked code rather than the code published on the public npm repository. | ||
|
||
## Licensing | ||
|
||
This project is licensed under the Apache V2 License. See [LICENSE](LICENSE) for more information. | ||
|