Skip to content
This repository was archived by the owner on Aug 4, 2023. It is now read-only.

Commit 360f226

Browse files
committed
Initial release
1 parent 2dfeb72 commit 360f226

File tree

16 files changed

+7474
-1
lines changed

16 files changed

+7474
-1
lines changed

.gitattributes

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
package-lock.json binary
2+

.gitignore

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Logs
2+
logs
3+
*.log
4+
npm-debug.log*
5+
6+
# Runtime data
7+
pids
8+
*.pid
9+
*.seed
10+
11+
# Directory for instrumented libs generated by jscoverage/JSCover
12+
lib-cov
13+
14+
# Coverage directory used by tools like istanbul
15+
coverage
16+
.nyc_output
17+
18+
# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
19+
.grunt
20+
21+
# node-waf configuration
22+
.lock-wscript
23+
24+
# Compiled binary addons (http://nodejs.org/api/addons.html)
25+
build/Release
26+
27+
# Dependency directory
28+
node_modules
29+
30+
# Optional npm cache directory
31+
.npm
32+
33+
# Optional REPL history
34+
.node_repl_history
35+
36+
# User specific stuff
37+
.idea/
38+
.DS_Store
39+
40+
.env
41+
.env.local
42+
43+
# Package items to ignore
44+
dist
45+
*.tgz

.npmignore

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Logs
2+
logs
3+
*.log
4+
npm-debug.log*
5+
6+
# Runtime data
7+
pids
8+
*.pid
9+
*.seed
10+
11+
# Directory for instrumented libs generated by jscoverage/JSCover
12+
lib-cov
13+
14+
# Coverage directory used by tools like istanbul
15+
coverage
16+
.nyc_output
17+
18+
# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
19+
.grunt
20+
21+
# node-waf configuration
22+
.lock-wscript
23+
24+
# Compiled binary addons (http://nodejs.org/api/addons.html)
25+
build/Release
26+
27+
# Dependency directory
28+
node_modules
29+
30+
# Optional npm cache directory
31+
.npm
32+
33+
# Optional REPL history
34+
.node_repl_history
35+
36+
# User specific stuff
37+
.idea/
38+
.DS_Store
39+
40+
.env
41+
.env.local
42+
43+
# Package items to ignore
44+
test
45+
*.tgz

.npmrc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
registry=https://registry.npmjs.com

CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# CHANGELOG
2+
3+
### 1.0.0
4+
5+
- Initial Version

CODE_OF_CONDUCT.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Contributor Covenant 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, sex characteristics, gender identity and expression,
9+
level of experience, education, socio-economic status, nationality, personal
10+
appearance, race, religion, or sexual identity and 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 within all project spaces, and it also applies when
49+
an individual is representing the project or its community in public spaces.
50+
Examples of representing a project or community include using an official
51+
project e-mail address, posting via an official social media account, or acting
52+
as an appointed representative at an online or offline event. Representation of
53+
a project may be 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 oss@godaddy.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 https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72+
73+
[homepage]: https://www.contributor-covenant.org
74+
75+
For answers to common questions about this code of conduct, see
76+
https://www.contributor-covenant.org/faq

CONTRIBUTING.md

Lines changed: 124 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,124 @@
1+
# Contributing
2+
3+
Everyone is welcome to contribute to GoDaddy's Open Source Software.
4+
Contributing doesn’t just mean submitting pull requests. To get involved,
5+
you can report or triage bugs, and participate in discussions on the
6+
evolution of each project.
7+
8+
No matter how you want to get involved, we ask that you first learn what’s
9+
expected of anyone who participates in the project by reading the Contribution
10+
Guidelines and our [Code of Conduct][coc].
11+
12+
**Please Note:** GitHub is for bug reports and contributions primarily -
13+
if you have a support question head over to [GoDaddy's Open Source
14+
Software Slack channel][slack]. You can request an invite
15+
[here][invite].
16+
17+
## Answering Questions
18+
19+
One of the most important and immediate ways you can support this project is
20+
to answer questions on [Slack][slack] or [Github][issues]. Whether you’re
21+
helping a newcomer understand a feature or troubleshooting an edge case with a
22+
seasoned developer, your knowledge and experience with a programming language
23+
can go a long way to help others.
24+
25+
## Reporting Bugs
26+
27+
**Do not report potential security vulnerabilities here. Refer to
28+
[SECURITY.md](./SECURITY.md) for more details about the process of reporting
29+
security vulnerabilities.**
30+
31+
Before submitting a ticket, please search our [Issue Tracker][issues] to make
32+
sure it does not already exist and have a simple replication of the behavior. If
33+
the issue is isolated to one of the dependencies of this project, please create
34+
a Github issue in that project. All dependencies should be open source software
35+
and can be found on Github.
36+
37+
Submit a ticket for your issue, assuming one does not already exist:
38+
- Create it on the project's [issue Tracker][issues].
39+
- Clearly describe the issue by following the template layout
40+
- Make sure to include steps to reproduce the bug.
41+
- A reproducible (unit) test could be helpful in solving the bug.
42+
- Describe the environment that (re)produced the problem.
43+
44+
## Triaging bugs or contributing code
45+
46+
If you're triaging a bug, first make sure that you can reproduce it. Once a bug
47+
can be reproduced, reduce it to the smallest amount of code possible. Reasoning
48+
about a sample or unit test that reproduces a bug in just a few lines of code
49+
is easier than reasoning about a longer sample.
50+
51+
From a practical perspective, contributions are as simple as:
52+
1. Fork and clone the repo, [see Github's instructions if you need help.][fork]
53+
1. Create a branch for your PR with `git checkout -b pr/your-branch-name`
54+
1. Make changes on the branch of your forked repository.
55+
1. When committing, reference your issue (if present) and include a note about
56+
the fix.
57+
1. Please also add/update unit tests for your changes.
58+
1. Push the changes to your fork and submit a pull request to the 'main
59+
development branch' branch of the projects' repository.
60+
61+
If you are interested in making a large change and feel unsure about its overall
62+
effect, start with opening an Issue in the project's [Issue Tracker][issues]
63+
with a high-level proposal and discuss it with the core contributors through
64+
Github comments or in [Slack][slack]. After reaching a consensus with core
65+
contributors about the change, discuss the best way to go about implementing it.
66+
67+
> Tip: Keep your master branch pointing at the original repository and make
68+
> pull requests from branches on your fork. To do this, run:
69+
> ```
70+
> git remote add upstream https://github.com/godaddy/webpack-rtlcss-plugin.git
71+
> git fetch upstream
72+
> git branch --set-upstream-to=upstream/master master
73+
> ```
74+
> This will add the original repository as a "remote" called "upstream," Then
75+
> fetch the git information from that remote, then set your local master
76+
> branch to use the upstream master branch whenever you run git pull. Then you
77+
> can make all of your pull request branches based on this master branch.
78+
> Whenever you want to update your version of master, do a regular git pull.
79+
80+
## Code Review
81+
82+
Any open source project relies heavily on code review to improve software
83+
quality. All significant changes, by all developers, must be reviewed before
84+
they are committed to the repository. Code reviews are conducted on GitHub
85+
through comments on pull requests or commits. The developer responsible for a
86+
code change is also responsible for making all necessary review-related changes.
87+
88+
Sometimes code reviews will take longer than you would hope for, especially for
89+
larger features. Here are some accepted ways to speed up review times for your
90+
patches:
91+
92+
- Review other people’s changes. If you help out, others will more likely be
93+
willing to do the same for you.
94+
- Split your change into multiple smaller changes. The smaller your change,
95+
the higher the probability that somebody will take a quick look at it.
96+
- Mention the change on [Slack][slack]. If it is urgent, provide reasons why it
97+
is important to get this change landed. Remember that you are asking for valuable
98+
time from other professional developers.
99+
100+
**Note that anyone is welcome to review and give feedback on a change, but only
101+
people with commit access to the repository can approve it.**
102+
103+
## Attribution of Changes
104+
105+
When contributors submit a change to this project, after that change is
106+
approved, other developers with commit access may commit it for the author. When
107+
doing so, it is important to retain correct attribution of the contribution.
108+
Generally speaking, Git handles attribution automatically.
109+
110+
## Code Style and Documentation
111+
112+
Ensure that your contribution follows the standards set by the project's style
113+
guide with respect to patterns, naming, documentation and testing.
114+
115+
# Additional Resources
116+
117+
- [General GitHub Documentation](https://help.github.com/)
118+
- [GitHub Pull Request documentation](https://help.github.com/send-pull-requests/)
119+
120+
[issues]: LINK_TO_PROJECTS_ISSUES_ON_GITHUB
121+
[coc]: ./CODE_OF_CONDUCT.md
122+
[slack]: https://godaddy-oss.slack.com/
123+
[fork]: https://help.github.com/en/articles/fork-a-repo
124+
[invite]: https://godaddy-oss-slack.herokuapp.com

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
The MIT License
2+
3+
Copyright (c) 2020 GoDaddy Operating Company, LLC
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in
13+
all copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21+
THE SOFTWARE.

README.md

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,30 @@
1-
# webpack-rtl-plugin
1+
# webpack-rtlcss-plugin
2+
3+
Webpack plugin that takes a `.css` chunk and processes RTL (right to left) conversion. Unlike other Webpack RTL plugins, this plugin __DOES NOT__ create a separate `.css` file.
4+
5+
Uses [rtlcss] under the hood. For more information on how to utilize [rtlcss] check out the [rtlcss docs](https://rtlcss.com/learn/).
6+
7+
## Install
8+
9+
```sh
10+
npm install @godaddy/webpack-rtlcss-plugin --save-dev
11+
```
12+
13+
## Usage
14+
15+
```js
16+
const RTLPlugin = require('@godaddy/webpack-rtlcss-plugin');
17+
18+
// Within Webpack config
19+
20+
plugins: [
21+
...other webpack plugins
22+
new RTLPlugin()
23+
],
24+
```
25+
26+
## Example
27+
28+
Check out the [test webpack config](./test/unit/webpack.config.js) to see an example of how `@godaddy/webpack-rtlcss-plugin` works with `mini-css-extract-plugin`.
29+
30+
[rtlcss]: https://github.com/MohammadYounes/rtlcss

0 commit comments

Comments
 (0)