Skip to content

Commit 702e751

Browse files
tripodsantripodsan
committedOct 30, 2020
chore(init): created repository from template
·
v7.1.12v1.0.0
0 parents  commit 702e751

25 files changed

+13396
-0
lines changed
 

‎.circleci/config.yml

+81
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
version: 2.1
2+
executors:
3+
node10:
4+
docker:
5+
- image: circleci/node:10-buster
6+
environment:
7+
NPM_CONFIG_PREFIX: ~/.npm-global
8+
9+
commands:
10+
setup:
11+
steps:
12+
- checkout
13+
# - restore_cache:
14+
# keys:
15+
# - v1-dependencies-{{ arch }}-{{ checksum "package-lock.json" }}
16+
- run:
17+
name: install latest npm
18+
command: sudo npm -g install npm
19+
- run:
20+
name: Installing Dependencies
21+
command: npm ci
22+
# - save_cache:
23+
# paths:
24+
# - node_modules
25+
# key: v1-dependencies-{{ arch }}-{{ checksum "package-lock.json" }}
26+
- run:
27+
name: prepare test git user
28+
command: git config --global user.email "circleci@example.com" && git config --global user.name "CircleCi Build"
29+
30+
jobs:
31+
build:
32+
executor: node10
33+
34+
steps:
35+
- setup
36+
- run: mkdir junit
37+
- run:
38+
name: Lint
39+
command: npm run lint
40+
41+
- run:
42+
name: Getting Code Coverage
43+
command: npm run test-ci
44+
45+
- store_test_results:
46+
path: junit
47+
48+
- store_artifacts:
49+
path: junit
50+
51+
release:
52+
executor: node10
53+
54+
steps:
55+
- setup
56+
- run:
57+
name: revert changes to package-lock.json
58+
command: git checkout -- package-lock.json
59+
60+
- run:
61+
name: Check for Updated Package name
62+
command: node -e "if (require('./package.json').name=='@adobe/helix-library') { process.exit(1) };"
63+
64+
- run:
65+
name: Semantic Release
66+
command: npm run semantic-release
67+
68+
workflows:
69+
version: 2
70+
build:
71+
jobs:
72+
- build
73+
# the release jobs needs a $NPM_TOKEN and $GH_TOKEN environment to be setup
74+
# but this should be covered by the CircleCI contexts setting below
75+
- release:
76+
context: Project Helix
77+
requires:
78+
- build
79+
filters:
80+
branches:
81+
only: main

‎.eslintignore

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
.vscode/*
2+
coverage/*

‎.eslintrc.js

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
/*
2+
* Copyright 2019 Adobe. All rights reserved.
3+
* This file is licensed to you under the Apache License, Version 2.0 (the "License");
4+
* you may not use this file except in compliance with the License. You may obtain a copy
5+
* of the License at http://www.apache.org/licenses/LICENSE-2.0
6+
*
7+
* Unless required by applicable law or agreed to in writing, software distributed under
8+
* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
9+
* OF ANY KIND, either express or implied. See the License for the specific language
10+
* governing permissions and limitations under the License.
11+
*/
12+
13+
module.exports = {
14+
root: true,
15+
extends: '@adobe/helix',
16+
};
17+

‎.github/ISSUE_TEMPLATE/bug_report.md

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
labels: bug
5+
6+
---
7+
8+
**Description**
9+
A clear and concise description of what the bug is.
10+
11+
**To Reproduce**
12+
Steps to reproduce the behavior:
13+
1. Go to '...'
14+
2. Click on '....'
15+
3. Scroll down to '....'
16+
4. See error
17+
18+
**Expected behavior**
19+
A clear and concise description of what you expected to happen.
20+
21+
**Screenshots**
22+
If applicable, add screenshots to help explain your problem.
23+
24+
**Version:**
25+
run: `$ hlx --version`
26+
27+
**Additional context**
28+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/discussion.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
name: Discussion
3+
about: Start a new discussion
4+
labels: question
5+
6+
---
7+
8+
## Overview
9+
whats' this discussion about?
10+
11+
## Details
12+
more details
13+
14+
## Proposed Actions
15+
and now?

‎.github/ISSUE_TEMPLATE/feature_request.md

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
labels: enhancement
5+
6+
---
7+
8+
**Is your feature request related to a problem? Please describe.**
9+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
10+
11+
**Describe the solution you'd like**
12+
A clear and concise description of what you want to happen.
13+
14+
**Describe alternatives you've considered**
15+
A clear and concise description of any alternative solutions or features you've considered.
16+
17+
**Additional context**
18+
Add any other context or screenshots about the feature request here.

‎.github/move.yml

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Configuration for move-issues - https://github.com/dessant/move-issues
2+
3+
# Delete the command comment when it contains no other content
4+
deleteCommand: true
5+
6+
# Close the source issue after moving
7+
closeSourceIssue: true
8+
9+
# Lock the source issue after moving
10+
lockSourceIssue: true
11+
12+
# Mention issue and comment authors
13+
mentionAuthors: true
14+
15+
# Preserve mentions in the issue content
16+
keepContentMentions: true

‎.github/pull_request_template.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Please ensure your pull request adheres to the following guidelines:
2+
- [ ] make sure to link the related issues in this description
3+
- [ ] when merging / squashing, make sure the fixed issue references are visible in the commits, for easy compilation of release notes
4+
5+
## Related Issues
6+
7+
8+
Thanks for contributing!

‎.github/workflows/semver-check.yaml

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
on:
2+
push:
3+
branches-ignore:
4+
- 'main'
5+
6+
jobs:
7+
ci_trigger:
8+
runs-on: ubuntu-latest
9+
name: Comment Semantic Release Status
10+
steps:
11+
- name: Comment
12+
id: comment
13+
uses: adobe-rnd/github-semantic-release-comment-action@master
14+
with:
15+
repo-token: ${{ secrets.GITHUB_TOKEN }}

‎.gitignore

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
coverage
2+
.nyc_output/
3+
node_modules/
4+
junit
5+
dist
6+
tmp
7+
logs
8+
.DS_Store
9+
test-results.xml

‎.jsdoc.json

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
{
2+
"plugins": [],
3+
"recurseDepth": 10,
4+
"source": {
5+
"includePattern": ".+\\.js(doc|x)?$",
6+
"excludePattern": "(^|\\/|\\\\)_"
7+
},
8+
"sourceType": "module",
9+
"tags": {
10+
"allowUnknownTags": true,
11+
"dictionaries": ["jsdoc","closure"]
12+
},
13+
"templates": {
14+
"cleverLinks": false,
15+
"monospaceLinks": false
16+
}
17+
}

‎.npmignore

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
coverage
2+
.nyc_output/
3+
node_modules/
4+
junit
5+
.idea
6+
test
7+
.snyk
8+
*.tgz
9+
build
10+
logs
11+
test-results.xml
12+
snykmocha.js
13+
.releaserc.js
14+
.eslintignore
15+
.eslintrc.js

‎.releaserc.js

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
module.exports = {
2+
plugins: [
3+
"@semantic-release/commit-analyzer",
4+
"@semantic-release/release-notes-generator",
5+
["@semantic-release/changelog", {
6+
"changelogFile": "CHANGELOG.md",
7+
}],
8+
"@semantic-release/npm",
9+
["@semantic-release/git", {
10+
"assets": ["package.json", "CHANGELOG.md"],
11+
"message": "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
12+
}],
13+
["@semantic-release/github", {}]
14+
]
15+
};

‎.renovaterc.json

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"extends": ["github>adobe/helix-shared"]
3+
}

‎.tidelift.yml

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
licensing:
2+
disallowed:
3+
- AGPL-1.0-only
4+
- AGPL-1.0-or-later
5+
- AGPL-3.0-only
6+
- AGPL-3.0-or-later
7+
- AGPL-1.0
8+
- AGPL-3.0
9+
- CC-BY-NC-ND-1.0
10+
- CC-BY-NC-ND-2.0
11+
- CC-BY-NC-ND-2.5
12+
- CC-BY-NC-ND-3.0
13+
- CC-BY-NC-ND-4.0
14+
- CC-BY-NC-SA-1.0
15+
- CC-BY-NC-SA-2.0
16+
- CC-BY-NC-SA-2.5
17+
- CC-BY-NC-SA-3.0
18+
- CC-BY-NC-SA-4.0
19+
- CC-BY-SA-1.0
20+
- CC-BY-SA-2.0
21+
- CC-BY-SA-2.5
22+
- CC-BY-SA-3.0
23+
- CC-BY-SA-4.0
24+
- GPL-1.0-only
25+
- GPL-1.0-or-later
26+
- GPL-2.0-only
27+
- GPL-2.0-or-later
28+
- GPL-3.0-only
29+
- GPL-3.0-or-later
30+
- SSPL-1.0
31+
- Sleepycat
32+
- Facebook

‎CHANGELOG.md

+120
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
1+
## [1.4.5](https://github.com/adobe/helix-library/compare/v1.4.4...v1.4.5) (2020-10-02)
2+
3+
4+
### Bug Fixes
5+
6+
* git init fails with -b argument ([#137](https://github.com/adobe/helix-library/issues/137)) ([5517a7f](https://github.com/adobe/helix-library/commit/5517a7f4e70862cad141f6bacef07bb085e719ce)), closes [#136](https://github.com/adobe/helix-library/issues/136)
7+
8+
## [1.4.4](https://github.com/adobe/helix-library/compare/v1.4.3...v1.4.4) (2020-08-21)
9+
10+
11+
### Bug Fixes
12+
13+
* **git:** use main branch ([d2afe19](https://github.com/adobe/helix-library/commit/d2afe19d929e1bdfa7ff4e7d68e5ffa9fd87c30c))
14+
15+
## [1.4.3](https://github.com/adobe/helix-library/compare/v1.4.2...v1.4.3) (2020-04-06)
16+
17+
18+
### Bug Fixes
19+
20+
* **deps:** update dependency chalk to v4 ([#95](https://github.com/adobe/helix-library/issues/95)) ([6e1812b](https://github.com/adobe/helix-library/commit/6e1812b5533e23dcf6eb6cb32898683e4329fd86))
21+
22+
## [1.4.2](https://github.com/adobe/helix-library/compare/v1.4.1...v1.4.2) (2020-03-24)
23+
24+
25+
### Bug Fixes
26+
27+
* **deps:** update dependency fs-extra to v9 ([#93](https://github.com/adobe/helix-library/issues/93)) ([c6dcea6](https://github.com/adobe/helix-library/commit/c6dcea67c54733b29d29980dca49ad4db30698df))
28+
29+
## [1.4.1](https://github.com/adobe/helix-library/compare/v1.4.0...v1.4.1) (2020-03-19)
30+
31+
32+
### Bug Fixes
33+
34+
* **index:** do not copy create-helix-service.js ([c3888b5](https://github.com/adobe/helix-library/commit/c3888b5bc2a47022a210f71806b01883f756d42a))
35+
36+
# [1.4.0](https://github.com/adobe/helix-library/compare/v1.3.2...v1.4.0) (2020-03-18)
37+
38+
39+
### Features
40+
41+
* **build:** add GitHub actions config ([e059085](https://github.com/adobe/helix-library/commit/e059085ac893712b0f503d511bab6af9ff175f6a))
42+
43+
## [1.3.2](https://github.com/adobe/helix-library/compare/v1.3.1...v1.3.2) (2020-01-27)
44+
45+
46+
### Bug Fixes
47+
48+
* **ci:** update ci ([#80](https://github.com/adobe/helix-library/issues/80)) ([4ce4230](https://github.com/adobe/helix-library/commit/4ce42308d13ee648f515378374d1f9364245c810))
49+
50+
## [1.3.1](https://github.com/adobe/helix-library/compare/v1.3.0...v1.3.1) (2020-01-19)
51+
52+
53+
### Bug Fixes
54+
55+
* **create:** ensure that dot files are included in npm released package ([#76](https://github.com/adobe/helix-library/issues/76)) ([a6a4944](https://github.com/adobe/helix-library/commit/a6a49441cec95bac8fa5cc8872e9fc2fba200a0b)), closes [#29](https://github.com/adobe/helix-library/issues/29)
56+
57+
# [1.3.0](https://github.com/adobe/helix-library/compare/v1.2.1...v1.3.0) (2019-11-21)
58+
59+
60+
### Features
61+
62+
* **circleci:** use Contexts for Env var management ([28837b5](https://github.com/adobe/helix-library/commit/28837b50f470594dfa93554701b28528d6f6bf1b))
63+
64+
## [1.2.1](https://github.com/adobe/helix-library/compare/v1.2.0...v1.2.1) (2019-11-21)
65+
66+
67+
### Bug Fixes
68+
69+
* **init:** add gitignore ([279fb38](https://github.com/adobe/helix-library/commit/279fb38042702868eb3c8c5a9a1765a903637b6b)), closes [#64](https://github.com/adobe/helix-library/issues/64)
70+
71+
# [1.2.0](https://github.com/adobe/helix-library/compare/v1.1.1...v1.2.0) (2019-11-21)
72+
73+
74+
### Features
75+
76+
* **init:** make the list of questions extensible ([d94684f](https://github.com/adobe/helix-library/commit/d94684fddd5dc1874f991f795968a0928fcf5a88))
77+
78+
## [1.1.1](https://github.com/adobe/helix-library/compare/v1.1.0...v1.1.1) (2019-11-20)
79+
80+
81+
### Bug Fixes
82+
83+
* **template:** remove old NPM option ([d2b1279](https://github.com/adobe/helix-library/commit/d2b1279f33abcae92010512d4abca1ca35161e2c))
84+
85+
# [1.1.0](https://github.com/adobe/helix-library/compare/v1.0.1...v1.1.0) (2019-11-20)
86+
87+
88+
### Bug Fixes
89+
90+
* **init:** include test files in new repo ([d6e28c6](https://github.com/adobe/helix-library/commit/d6e28c637215e5332fce9cc6919e88b2d63f1b22)), closes [#63](https://github.com/adobe/helix-library/issues/63)
91+
92+
93+
### Features
94+
95+
* **init:** expose init as an extensible function ([8544810](https://github.com/adobe/helix-library/commit/85448100e7f0f15979db900bb975b691906e86d7))
96+
97+
## [1.0.1](https://github.com/adobe/helix-library/compare/v1.0.0...v1.0.1) (2019-11-20)
98+
99+
100+
### Bug Fixes
101+
102+
* **init:** include files from npmignore in templates ([e17618b](https://github.com/adobe/helix-library/commit/e17618b86f3efd38fc586a451b30a0b0e52d2792)), closes [#62](https://github.com/adobe/helix-library/issues/62)
103+
104+
# 1.0.0 (2019-11-20)
105+
106+
107+
### Bug Fixes
108+
109+
* **package:** npm test script should provide information about failing tests ([#34](https://github.com/adobe/helix-library/issues/34)) ([be08076](https://github.com/adobe/helix-library/commit/be0807685dcb9e5367d8770651cbc5e37536abeb)), closes [#33](https://github.com/adobe/helix-library/issues/33)
110+
111+
112+
### Features
113+
114+
* **init:** copy default files, patch package.json ([4c551d8](https://github.com/adobe/helix-library/commit/4c551d8c57affd28013d14f1473866a692ad5d2e))
115+
* **init:** create initializer script for bootstrapping Helix library projects ([c879e4c](https://github.com/adobe/helix-library/commit/c879e4cd9c2a26cc33a139a3c47047aaa5184baa))
116+
* **init:** enable patching of package-lock.json ([f5d35d3](https://github.com/adobe/helix-library/commit/f5d35d34379fd4e2486f5ba174990524f96762f3))
117+
* **init:** enable patching README.md ([7ed14dc](https://github.com/adobe/helix-library/commit/7ed14dc87c7edc5d84864fee867aada02c66caf4))
118+
* **init:** enable pushing new repo to github ([a4fe5ad](https://github.com/adobe/helix-library/commit/a4fe5ad20bcd77e2719aba3d5f2fea832fee5192))
119+
* **init:** separate between npm and github org ([c728193](https://github.com/adobe/helix-library/commit/c72819310798c0be1bab4f606d650554de566518))
120+
* **init:** turn init into a proper executable ([5ec8d64](https://github.com/adobe/helix-library/commit/5ec8d64df28ef6fb6e7c0a390cfc697d8cf8a9a5))

‎CODE_OF_CONDUCT.md

+74
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# Adobe Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, gender identity and expression, level of experience,
9+
nationality, personal appearance, race, religion, or sexual identity and
10+
orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at Grp-opensourceoffice@adobe.com. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at [http://contributor-covenant.org/version/1/4][version]
72+
73+
[homepage]: http://contributor-covenant.org
74+
[version]: http://contributor-covenant.org/version/1/4/

‎CONTRIBUTING.md

+74
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# Contributing to Project Helix
2+
3+
This project (like almost all of Project Helix) is an Open Development project and welcomes contributions from everyone who finds it useful or lacking.
4+
5+
## Code Of Conduct
6+
7+
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 cstaub at adobe dot com.
8+
9+
## Contributor License Agreement
10+
11+
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 good to go!
12+
13+
## Things to Keep in Mind
14+
15+
This project uses a **commit then review** process, which means that for approved maintainers, changes can be merged immediately, but will be reviewed by others.
16+
17+
For other contributors, a maintainer of the project has to approve the pull request.
18+
19+
# Before You Contribute
20+
21+
* Check that there is an existing issue in GitHub issues
22+
* Check if there are other pull requests that might overlap or conflict with your intended contribution
23+
24+
# How to Contribute
25+
26+
1. Fork the repository
27+
2. Make some changes on a branch on your fork
28+
3. Create a pull request from your branch
29+
30+
In your pull request, outline:
31+
32+
* What the changes intend
33+
* How they change the existing code
34+
* If (and what) they breaks
35+
* Start the pull request with the GitHub issue ID, e.g. #123
36+
37+
Lastly, please follow the [pull request template](.github/pull_request_template.md) when submitting a pull request!
38+
39+
Each commit message that is not part of a pull request:
40+
41+
* Should contain the issue ID like `#123`
42+
* Can contain the tag `[trivial]` for trivial changes that don't relate to an issue
43+
44+
45+
46+
## Coding Styleguides
47+
48+
We enforce a coding styleguide using `eslint`. As part of your build, run `npm run lint` to check if your code is conforming to the style guide. We do the same for every PR in our CI, so PRs will get rejected if they don't follow the style guide.
49+
50+
You can fix some of the issues automatically by running `npx eslint . --fix`.
51+
52+
## Commit Message Format
53+
54+
This project uses a structured commit changelog format that should be used for every commit. Use `npm run commit` instead of your usual `git commit` to generate commit messages using a wizard.
55+
56+
```bash
57+
# either add all changed files
58+
$ git add -A
59+
# or selectively add files
60+
$ git add package.json
61+
# then commit using the wizard
62+
$ npm run commit
63+
```
64+
65+
# How Contributions get Reviewed
66+
67+
One of the maintainers will look at the pull request within one week. Feedback on the pull request will be given in writing, in GitHub.
68+
69+
# Release Management
70+
71+
The project's committers will release to the [Adobe organization on npmjs.org](https://www.npmjs.com/org/adobe).
72+
Please contact the [Adobe Open Source Advisory Board](https://git.corp.adobe.com/OpenSourceAdvisoryBoard/discuss/issues) to get access to the npmjs organization.
73+
74+
The release process is fully automated using `semantic-release`, increasing the version numbers, etc. based on the contents of the commit messages found.

‎LICENSE.txt

+264
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,264 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright [yyyy] [name of copyright owner]
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.
203+
204+
205+
APACHE JACKRABBIT SUBCOMPONENTS
206+
207+
Apache Jackrabbit includes parts with separate copyright notices and license
208+
terms. Your use of these subcomponents is subject to the terms and conditions
209+
of the following licenses:
210+
211+
XPath 2.0/XQuery 1.0 Parser:
212+
http://www.w3.org/2002/11/xquery-xpath-applets/xgrammar.zip
213+
214+
Copyright (C) 2002 World Wide Web Consortium, (Massachusetts Institute of
215+
Technology, European Research Consortium for Informatics and Mathematics,
216+
Keio University). All Rights Reserved.
217+
218+
This work is distributed under the W3C(R) Software License in the hope
219+
that it will be useful, but WITHOUT ANY WARRANTY; without even the
220+
implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
221+
222+
W3C(R) SOFTWARE NOTICE AND LICENSE
223+
http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231
224+
225+
This work (and included software, documentation such as READMEs, or
226+
other related items) is being provided by the copyright holders under
227+
the following license. By obtaining, using and/or copying this work,
228+
you (the licensee) agree that you have read, understood, and will comply
229+
with the following terms and conditions.
230+
231+
Permission to copy, modify, and distribute this software and its
232+
documentation, with or without modification, for any purpose and
233+
without fee or royalty is hereby granted, provided that you include
234+
the following on ALL copies of the software and documentation or
235+
portions thereof, including modifications:
236+
237+
1. The full text of this NOTICE in a location viewable to users
238+
of the redistributed or derivative work.
239+
240+
2. Any pre-existing intellectual property disclaimers, notices,
241+
or terms and conditions. If none exist, the W3C Software Short
242+
Notice should be included (hypertext is preferred, text is
243+
permitted) within the body of any redistributed or derivative code.
244+
245+
3. Notice of any changes or modifications to the files, including
246+
the date changes were made. (We recommend you provide URIs to the
247+
location from which the code is derived.)
248+
249+
THIS SOFTWARE AND DOCUMENTATION IS PROVIDED "AS IS," AND COPYRIGHT
250+
HOLDERS MAKE NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED,
251+
INCLUDING BUT NOT LIMITED TO, WARRANTIES OF MERCHANTABILITY OR FITNESS
252+
FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF THE SOFTWARE OR
253+
DOCUMENTATION WILL NOT INFRINGE ANY THIRD PARTY PATENTS, COPYRIGHTS,
254+
TRADEMARKS OR OTHER RIGHTS.
255+
256+
COPYRIGHT HOLDERS WILL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL
257+
OR CONSEQUENTIAL DAMAGES ARISING OUT OF ANY USE OF THE SOFTWARE OR
258+
DOCUMENTATION.
259+
260+
The name and trademarks of copyright holders may NOT be used in
261+
advertising or publicity pertaining to the software without specific,
262+
written prior permission. Title to copyright in this software and
263+
any associated documentation will at all times remain with
264+
copyright holders.

‎README.md

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Helix Markdown Support
2+
3+
> Various markdown related parsing, processing and stringification utilities.
4+
5+
## Status
6+
[![codecov](https://img.shields.io/codecov/c/github/adobe/helix-markdown-support.svg)](https://codecov.io/gh/adobe/helix-markdown-support)
7+
[![CircleCI](https://img.shields.io/circleci/project/github/adobe/helix-markdown-support.svg)](https://circleci.com/gh/adobe/helix-markdown-support)
8+
[![GitHub license](https://img.shields.io/github/license/adobe/helix-markdown-support.svg)](https://github.com/adobe/helix-markdown-support/blob/master/LICENSE.txt)
9+
[![GitHub issues](https://img.shields.io/github/issues/adobe/helix-markdown-support.svg)](https://github.com/adobe/helix-markdown-support/issues)
10+
[![LGTM Code Quality Grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/adobe/helix-markdown-support.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/adobe/helix-markdown-support)
11+
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
12+
13+
## Installation
14+
15+
```bash
16+
$ npm install @adobe/helix-markdown-support
17+
```
18+
19+
## Usage
20+
21+
See the [API documentation](docs/API.md).
22+
23+
## Development
24+
25+
### Build
26+
27+
```bash
28+
$ npm install
29+
```
30+
31+
### Test
32+
33+
```bash
34+
$ npm test
35+
```
36+
37+
### Lint
38+
39+
```bash
40+
$ npm run lint
41+
```

‎docs/API.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
<a name="main"></a>
2+
3+
## main(name) ⇒ <code>string</code>
4+
This is the main function
5+
6+
**Kind**: global function
7+
**Returns**: <code>string</code> - a greeting
8+
9+
| Param | Type | Default | Description |
10+
| --- | --- | --- | --- |
11+
| name | <code>string</code> | <code>&quot;world&quot;</code> | name of the person to greet |
12+

‎package-lock.json

+12,418
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎package.json

+55
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
{
2+
"name": "@adobe/helix-markdown-support",
3+
"version": "0.0.1",
4+
"description": "Helix Markdown Support",
5+
"main": "src/index.js",
6+
"scripts": {
7+
"test": " nyc --reporter=text --reporter=lcov --check-coverage --branches 100 --statements 100 --lines 100 mocha",
8+
"test-ci": "nyc --reporter=text --reporter=lcov --check-coverage --branches 100 --statements 100 --lines 100 mocha --reporter xunit --reporter-options output=./junit/test-results.xml && codecov",
9+
"lint": "./node_modules/.bin/eslint .",
10+
"semantic-release": "semantic-release",
11+
"docs": "npx jsdoc2md -c .jsdoc.json --files 'src/*.js' > docs/API.md",
12+
"commit": "git-cz"
13+
},
14+
"repository": {
15+
"type": "git",
16+
"url": "https://github.com/adobe/helix-markdown-support"
17+
},
18+
"author": "",
19+
"license": "Apache-2.0",
20+
"bugs": {
21+
"url": "https://github.com/adobe/helix-markdown-support/issues"
22+
},
23+
"homepage": "https://github.com/adobe/helix-markdown-support#readme",
24+
"dependencies": {},
25+
"devDependencies": {
26+
"@adobe/eslint-config-helix": "1.1.3",
27+
"@semantic-release/changelog": "5.0.1",
28+
"@semantic-release/git": "9.0.0",
29+
"@semantic-release/npm": "7.0.6",
30+
"ajv": "6.12.5",
31+
"codecov": "3.7.2",
32+
"commitizen": "4.2.1",
33+
"cz-conventional-changelog": "3.3.0",
34+
"eslint": "7.10.0",
35+
"eslint-plugin-header": "3.1.0",
36+
"eslint-plugin-import": "2.22.0",
37+
"jsdoc-to-markdown": "6.0.1",
38+
"junit-report-builder": "2.1.0",
39+
"lint-staged": "10.4.0",
40+
"mocha": "7.2.0",
41+
"nyc": "15.1.0",
42+
"semantic-release": "17.1.2"
43+
},
44+
"lint-staged": {
45+
"*.js": "eslint"
46+
},
47+
"config": {
48+
"commitizen": {
49+
"path": "node_modules/cz-conventional-changelog"
50+
},
51+
"ghooks": {
52+
"pre-commit": "npx lint-staged"
53+
}
54+
}
55+
}

‎src/index.js

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
/*
2+
* Copyright 2019 Adobe. All rights reserved.
3+
* This file is licensed to you under the Apache License, Version 2.0 (the "License");
4+
* you may not use this file except in compliance with the License. You may obtain a copy
5+
* of the License at http://www.apache.org/licenses/LICENSE-2.0
6+
*
7+
* Unless required by applicable law or agreed to in writing, software distributed under
8+
* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
9+
* OF ANY KIND, either express or implied. See the License for the specific language
10+
* governing permissions and limitations under the License.
11+
*/
12+
13+
/**
14+
* This is the main function
15+
* @param {string} name name of the person to greet
16+
* @returns {string} a greeting
17+
*/
18+
function main(name = 'world') {
19+
return `Hello, ${name}.`;
20+
}
21+
22+
module.exports = { main };

‎test/index.test.js

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
/*
2+
* Copyright 2019 Adobe. All rights reserved.
3+
* This file is licensed to you under the Apache License, Version 2.0 (the "License");
4+
* you may not use this file except in compliance with the License. You may obtain a copy
5+
* of the License at http://www.apache.org/licenses/LICENSE-2.0
6+
*
7+
* Unless required by applicable law or agreed to in writing, software distributed under
8+
* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
9+
* OF ANY KIND, either express or implied. See the License for the specific language
10+
* governing permissions and limitations under the License.
11+
*/
12+
13+
/* eslint-env mocha */
14+
15+
'use strict';
16+
17+
const assert = require('assert');
18+
const index = require('../src/index.js').main;
19+
20+
describe('Index Tests', () => {
21+
it('index function is present', async () => {
22+
const result = await index();
23+
assert.equal(result, 'Hello, world.');
24+
});
25+
});

0 commit comments

Comments
 (0)
Please sign in to comment.