Skip to content
This repository was archived by the owner on Jul 18, 2025. It is now read-only.

Commit 0c02535

Browse files
authored
Prettier fixes (#42)
* Prettier format fixes [atomist:generated] [atomist-skill:atomist/prettier-skill] Pull request auto merged: * No reviews * 1 successful check
1 parent a2c5193 commit 0c02535

File tree

4 files changed

+140
-142
lines changed

4 files changed

+140
-142
lines changed

CODE_OF_CONDUCT.md

Lines changed: 40 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# Contributor Covenant Code of Conduct
22

33
In the interest of fostering an open and welcoming environment, we as
4-
contributors and maintainers pledge to making participation in our
5-
project and our community a harassment-free experience for everyone,
6-
regardless of age, body size, disability, ethnicity, gender identity
7-
and expression, level of experience, nationality, personal appearance,
8-
race, religion, or sexual identity and orientation.
4+
contributors and maintainers pledge to making participation in our project and
5+
our community a harassment-free experience for everyone, regardless of age, body
6+
size, disability, ethnicity, gender identity and expression, level of
7+
experience, nationality, personal appearance, race, religion, or sexual identity
8+
and orientation.
99

10-
Examples of behavior that contributes to creating a positive
11-
environment include:
10+
Examples of behavior that contributes to creating a positive environment
11+
include:
1212

1313
- Using welcoming and inclusive language
1414
- Being respectful of differing viewpoints and experiences
@@ -18,51 +18,46 @@ environment include:
1818

1919
Examples of unacceptable behavior by participants include:
2020

21-
- The use of sexualized language or imagery and unwelcome sexual
22-
attention or advances
23-
- Trolling, insulting/derogatory comments, and personal or political
24-
attacks
21+
- The use of sexualized language or imagery and unwelcome sexual attention or
22+
advances
23+
- Trolling, insulting/derogatory comments, and personal or political attacks
2524
- Public or private harassment
26-
- Publishing others' private information, such as a physical or
27-
electronic address, without explicit permission
28-
- Other conduct which could reasonably be considered inappropriate
29-
in a professional setting
25+
- Publishing others' private information, such as a physical or electronic
26+
address, without explicit permission
27+
- Other conduct which could reasonably be considered inappropriate in a
28+
professional setting
3029

31-
Project maintainers are responsible for clarifying the standards of
32-
acceptable behavior and are expected to take appropriate and fair
33-
corrective action in response to any instances of unacceptable
34-
behavior.
30+
Project maintainers are responsible for clarifying the standards of acceptable
31+
behavior and are expected to take appropriate and fair corrective action in
32+
response to any instances of unacceptable behavior.
3533

36-
Project maintainers have the right and responsibility to remove, edit,
37-
or reject comments, commits, code, wiki edits, issues, and other
38-
contributions that are not aligned to this Code of Conduct, or to ban
39-
temporarily or permanently any contributor for other behaviors that
40-
they deem inappropriate, threatening, offensive, or harmful.
34+
Project maintainers have the right and responsibility to remove, edit, or reject
35+
comments, commits, code, wiki edits, issues, and other contributions that are
36+
not aligned to this Code of Conduct, or to ban temporarily or permanently any
37+
contributor for other behaviors that they deem inappropriate, threatening,
38+
offensive, or harmful.
4139

42-
This Code of Conduct applies both within project spaces and in public
43-
spaces when an individual is representing the project or its
44-
community. Examples of representing a project or community include
45-
using an official project e-mail address, posting via an official
46-
social media account, or acting as an appointed representative at an
47-
online or offline event. Representation of a project may be further
48-
defined and clarified by project maintainers.
40+
This Code of Conduct applies both within project spaces and in public spaces
41+
when an individual is representing the project or its community. Examples of
42+
representing a project or community include using an official project e-mail
43+
address, posting via an official social media account, or acting as an appointed
44+
representative at an online or offline event. Representation of a project may be
45+
further defined and clarified by project maintainers.
4946

50-
Instances of abusive, harassing, or otherwise unacceptable behavior
51-
may be reported by contacting the project team
52-
at [code-of-conduct@atomist.com][email]. All complaints will be
53-
reviewed and investigated and will result in a response that is deemed
54-
necessary and appropriate to the circumstances. The project team is
55-
obligated to maintain confidentiality with regard to the reporter of
56-
an incident. Further details of specific enforcement policies may be
57-
posted separately.
47+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
48+
reported by contacting the project team at [code-of-conduct@atomist.com][email].
49+
All complaints will be reviewed and investigated and will result in a response
50+
that is deemed necessary and appropriate to the circumstances. The project team
51+
is obligated to maintain confidentiality with regard to the reporter of an
52+
incident. Further details of specific enforcement policies may be posted
53+
separately.
5854

59-
Project maintainers who do not follow or enforce the Code of Conduct
60-
in good faith may face temporary or permanent repercussions as
61-
determined by other members of the project's leadership.
55+
Project maintainers who do not follow or enforce the Code of Conduct in good
56+
faith may face temporary or permanent repercussions as determined by other
57+
members of the project's leadership.
6258

63-
This Code of Conduct is adapted from
64-
the [Contributor Covenant][homepage], version 1.4, available
65-
at [http://contributor-covenant.org/version/1/4][version]
59+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
60+
version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
6661

6762
[homepage]: http://contributor-covenant.org
6863
[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

Lines changed: 47 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,39 @@
11
# Contributing to Atomist open source projects
22

3-
Have something you would like to contribute to this project? Awesome,
4-
and thanks for taking time to contribute! Here's what you need to
5-
know.
3+
Have something you would like to contribute to this project? Awesome, and thanks
4+
for taking time to contribute! Here's what you need to know.
65

76
## Contributing code
87

9-
Is there an improvement to existing functionality or an entirely new
10-
feature you would like to see? Before creating enhancement
11-
suggestions, please check the issue list as you might find out that
12-
you don't need to create one.
13-
14-
Did you know we have a [Slack community][slack]? This might be a
15-
great place to talk through your idea before starting. It allows you
16-
to see if anyone else is already working on something similar, having
17-
the same issue or to get feedback on your enhancement idea.
18-
Discussing things with the community first is likely to make the
19-
contribution process a better experience for yourself and those that
8+
Is there an improvement to existing functionality or an entirely new feature you
9+
would like to see? Before creating enhancement suggestions, please check the
10+
issue list as you might find out that you don't need to create one.
11+
12+
Did you know we have a [Slack community][slack]? This might be a great place to
13+
talk through your idea before starting. It allows you to see if anyone else is
14+
already working on something similar, having the same issue or to get feedback
15+
on your enhancement idea. Discussing things with the community first is likely
16+
to make the contribution process a better experience for yourself and those that
2017
are maintaining the projects.
2118

2219
[slack]: https://join.atomist.com/
2320

24-
If you do not find an open issue related to your contribution and
25-
discussions in the Slack community are positive, the next thing to do
26-
is to create an issue in the appropriate GitHub repository.
21+
If you do not find an open issue related to your contribution and discussions in
22+
the Slack community are positive, the next thing to do is to create an issue in
23+
the appropriate GitHub repository.
2724

28-
- Before we can accept any code changes into the Atomist codebase,
29-
we need to get some of the legal stuff covered. This is pretty
30-
standard for open-source projects. We are using
31-
[cla-assisant.io][cla-assistant] to track our Contributor License
32-
Agreement (CLA) signatures. If you have not signed a CLA for the
33-
repository to which you are contributing, you will be prompted to
25+
- Before we can accept any code changes into the Atomist codebase, we need to
26+
get some of the legal stuff covered. This is pretty standard for open-source
27+
projects. We are using [cla-assisant.io][cla-assistant] to track our
28+
Contributor License Agreement (CLA) signatures. If you have not signed a CLA
29+
for the repository to which you are contributing, you will be prompted to
3430
when you create a pull request (PR).
3531
- Be sure there is an open issue related to the contribution.
3632
- Code contributions should successfully build and pass tests.
37-
- Commit messages should follow the [standard format][commit] and
38-
should include a [reference][ref] to the open issue they are
39-
addressing.
40-
- All code contributions should be submitted via
41-
a [pull request (PR) from a forked GitHub repository][pr].
33+
- Commit messages should follow the [standard format][commit] and should
34+
include a [reference][ref] to the open issue they are addressing.
35+
- All code contributions should be submitted via a [pull request (PR) from a
36+
forked GitHub repository][pr].
4237
- Your PR will be reviewed by an Atomist developer.
4338

4439
[cla-assistant]: https://cla-assistant.io/
@@ -48,37 +43,35 @@ is to create an issue in the appropriate GitHub repository.
4843

4944
## Reporting problems
5045

51-
Please go through the checklist below before reporting a
52-
problem. There's a chance it may have already been reported, or
53-
resolved.
46+
Please go through the checklist below before reporting a problem. There's a
47+
chance it may have already been reported, or resolved.
5448

55-
- Check if you can reproduce the problem in the latest version of
56-
the project.
57-
- Search the [atomist-community Slack][slack] community for common
58-
questions and problems.
49+
- Check if you can reproduce the problem in the latest version of the project.
50+
- Search the [atomist-community Slack][slack] community for common questions
51+
and problems.
5952
- Understand which repo the bug should be reported in.
60-
- Scan the list of issues to see if the problem has previously been
61-
reported. If so, you may add a comment to the existing issue
62-
rather than creating a new one.
53+
- Scan the list of issues to see if the problem has previously been reported.
54+
If so, you may add a comment to the existing issue rather than creating a
55+
new one.
6356

64-
You went through the list above and it is still something you would
65-
like to report? Then, please provide us with as much of the context,
66-
by explaininig the problem and including any additional details that
67-
would help maintainers reproduce the problem. The more details you
68-
provide in the bug report, the better.
57+
You went through the list above and it is still something you would like to
58+
report? Then, please provide us with as much of the context, by explaininig the
59+
problem and including any additional details that would help maintainers
60+
reproduce the problem. The more details you provide in the bug report, the
61+
better.
6962

70-
Bugs are tracked as GitHub issues. After you've determined which
71-
repository your bug is related to, create an issue on that repository
72-
and provide as much information as possible. Feel free to use
73-
the bug report template below if you like.
63+
Bugs are tracked as GitHub issues. After you've determined which repository your
64+
bug is related to, create an issue on that repository and provide as much
65+
information as possible. Feel free to use the bug report template below if you
66+
like.
7467

7568
At a minimum include the following:
7669

77-
- Where did you find the bug? For example, did you encounter the bug
78-
in chat, the CLI, somewhere else?
70+
- Where did you find the bug? For example, did you encounter the bug in chat,
71+
the CLI, somewhere else?
7972
- What version are you using?
80-
- What command were you using when it happened? (including
81-
parameters where applicable)
73+
- What command were you using when it happened? (including parameters where
74+
applicable)
8275

8376
```
8477
[Description of the problem]
@@ -105,10 +98,9 @@ At a minimum include the following:
10598
**Atomist CLI version:** [Enter CLI version]
10699
```
107100

108-
This project adheres to the Contributor Covenant [code of
109-
conduct][conduct]. By participating, you are expected to uphold this
110-
code. Please report unacceptable behavior to
111-
[code-of-conduct@atomist.com][email].
101+
This project adheres to the Contributor Covenant [code of conduct][conduct]. By
102+
participating, you are expected to uphold this code. Please report unacceptable
103+
behavior to [code-of-conduct@atomist.com][email].
112104

113105
[conduct]: CODE_OF_CONDUCT.md
114106
[email]: mailto:code-of-conduct@atomist.com

README.md

Lines changed: 35 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,16 @@ Run npm scripts to compile or test your JavaScript project
1212

1313
# What it's useful for
1414

15-
Run npm scripts with different versions of Node.js and npm in a consistent container environment.
16-
When your tests pass, you can immediately publish the package to the npmjs.com Registry.
15+
Run npm scripts with different versions of Node.js and npm in a consistent
16+
container environment. When your tests pass, you can immediately publish the
17+
package to the npmjs.com Registry.
1718

18-
- Set up this skill with multiple configurations to run your tests on different versions of Node.js
19-
- Decide to publish your packages consistently from a centralized configuration
20-
- Own the container environment and install tools needed for your build and test
19+
- Set up this skill with multiple configurations to run your tests on
20+
different versions of Node.js
21+
- Decide to publish your packages consistently from a centralized
22+
configuration
23+
- Own the container environment and install tools needed for your build and
24+
test
2125

2226
# Before you get started
2327

@@ -27,34 +31,38 @@ Connect and configure this integration:
2731
- **npmjs.com Registry**
2832
- **Slack or Microsoft Teams**
2933

30-
The **GitHub** integration must be configured in order to use this skill. At least one repository must be selected.
31-
If you want to publish a npm package to npmjs.com, you need to connect an **npmjs.com Registry**. We recommend
32-
that you configure the **Slack** or **Microsoft Teams** integration.
34+
The **GitHub** integration must be configured in order to use this skill. At
35+
least one repository must be selected. If you want to publish a npm package to
36+
npmjs.com, you need to connect an **npmjs.com Registry**. We recommend that you
37+
configure the **Slack** or **Microsoft Teams** integration.
3338

3439
# How to configure
3540

3641
1. **Configure npm scripts to run**
3742

38-
Provide the name of the npm scripts from the project's `package.json` scripts section.
39-
The order in which the scripts are specified is the order in which they will get executed.
40-
If one script fails, the execution stops.
43+
Provide the name of the npm scripts from the project's `package.json`
44+
scripts section. The order in which the scripts are specified is the order
45+
in which they will get executed. If one script fails, the execution stops.
4146

4247
1. **Define Node.js version**
4348

44-
Provide a valid Node.js version or alias as used by [nvm](https://github.com/nvm-sh/nvm#usage).
49+
Provide a valid Node.js version or alias as used by
50+
[nvm](https://github.com/nvm-sh/nvm#usage).
4551

4652
1. **Decide if the package should be published after running the scripts**
4753

48-
When checked, the skill will run `npm publish` after successful execution of the configured
49-
scripts.
54+
When checked, the skill will run `npm publish` after successful execution of
55+
the configured scripts.
5056

5157
1. **Define package access**
5258

53-
`npm publish` allows to publish packages with `public` or `restricted` access.
59+
`npm publish` allows to publish packages with `public` or `restricted`
60+
access.
5461

5562
1. **Create additional npm distribution tags**
5663

57-
Specify additional [distribution tags](https://docs.npmjs.com/adding-dist-tags-to-packages)
64+
Specify additional
65+
[distribution tags](https://docs.npmjs.com/adding-dist-tags-to-packages)
5866
like `next` or `stable` for the published version of the package.
5967

6068
1. **Tag the Git commit on successful execution**
@@ -63,8 +71,9 @@ that you configure the **Slack** or **Microsoft Teams** integration.
6371

6472
1. **Specify an optional bash command**
6573

66-
In case your npm scripts need different tools - like databases - you can use this parameter
67-
to install such tools. Provide a command that can in a Ubuntu 20.04 LTS container.
74+
In case your npm scripts need different tools - like databases - you can use
75+
this parameter to install such tools. Provide a command that can in a Ubuntu
76+
20.04 LTS container.
6877

6978
Here's is an example on how to install MongoDB and start it:
7079

@@ -82,12 +91,14 @@ that you configure the **Slack** or **Microsoft Teams** integration.
8291

8392
1. **Enable file caching for faster execution times**
8493

85-
You can speed up executions times by enabling file caching for certain artifacts — for example, dependencies —
86-
by providing glob patterns of files you'd like to cache between executions.
94+
You can speed up executions times by enabling file caching for certain
95+
artifacts — for example, dependencies — by providing glob patterns of files
96+
you'd like to cache between executions.
8797
8898
Note that only files within the `/atm/home` directory can be cached.
8999
90-
Caching the npm dependency cache could be accomplished with the following pattern:
100+
Caching the npm dependency cache could be accomplished with the following
101+
pattern:
91102
92103
`.npm/**`
93104
@@ -107,15 +118,15 @@ that you configure the **Slack** or **Microsoft Teams** integration.
107118
108119
1. **Enjoy automatic and consistent execution of npm scripts on every push**
109120
110-
To create feature requests or bug reports, create an [issue in the repository for this skill](https://github.com/atomist-skills/npm-build-skill/issues).
121+
To create feature requests or bug reports, create an
122+
[issue in the repository for this skill](https://github.com/atomist-skills/npm-build-skill/issues).
111123
See the [code](https://github.com/atomist-skills/npm-build-skill) for the skill.
112124
113125
<!---atomist-skill-readme:end--->
114126
115127
---
116128
117-
Created by [Atomist][atomist].
118-
Need Help? [Join our Slack workspace][slack].
129+
Created by [Atomist][atomist]. Need Help? [Join our Slack workspace][slack].
119130
120131
[atomist]: https://atomist.com/ "Atomist - How Teams Deliver Software"
121132
[slack]: https://join.atomist.com/ "Atomist Community Slack"

0 commit comments

Comments
 (0)