-
Notifications
You must be signed in to change notification settings - Fork 3
Full Code Review for Open Source Approval #11
Changes from all commits
90b5ea1
4271a5a
bf7974a
438afc3
02a09da
786746d
378691c
ad180a5
c993757
2ed1c6d
a3b548c
931897c
c8e9d69
bd361de
f8eb8d4
7ce1a27
1d44c32
e4c430b
8c31ce6
65e4718
d771801
8f97327
ee42465
9891199
785fec8
9eb942b
43e2412
4539f79
60722f1
f9af06b
c89a992
5c8ecee
40818a7
cb3ad84
368c770
7b73870
8c48196
944c59b
4cecde0
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| # Javascript Node CircleCI 2.0 configuration file | ||
| # | ||
| # Check https://circleci.com/docs/2.0/language-javascript/ for more details | ||
| # | ||
| version: 2 | ||
| jobs: | ||
| build: | ||
| docker: | ||
| - image: circleci/node:8.11 | ||
|
|
||
| working_directory: ~/fluent-react-utils | ||
|
|
||
| steps: | ||
| - checkout | ||
|
|
||
| - run: sudo npm install -g lerna | ||
| - run: lerna bootstrap |
This file was deleted.
This file was deleted.
This file was deleted.
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| * @hkasemir |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,21 +1,13 @@ | ||
| The MIT License (MIT) | ||
| Copyright 2018 Udacity | ||
|
|
||
| Copyright (c) 2018 Dineshkumar Pandiyan <flexdinesh@gmail.com> | ||
| 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 | ||
|
|
||
| Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| of this software and associated documentation files (the "Software"), to deal | ||
| in the Software without restriction, including without limitation the rights | ||
| to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| copies of the Software, and to permit persons to whom the Software is | ||
| furnished to do so, subject to the following conditions: | ||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
|
|
||
| The above copyright notice and this permission notice shall be included in all | ||
| copies or substantial portions of the Software. | ||
|
|
||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| SOFTWARE. | ||
| 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. | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,37 +1,19 @@ | ||
| # NPM Module Boilerplate | ||
| # fluent-react-utils | ||
| String extraction and helper components for using [fluent-react](https://github.com/projectfluent/fluent.js/tree/master/fluent-react) in your projects. | ||
|
|
||
| [](https://travis-ci.org/flexdinesh/npm-module-boilerplate) [](https://david-dm.org/flexdinesh/npm-module-boilerplate) [](https://david-dm.org/flexdinesh/npm-module-boilerplate?type=dev) [](https://opensource.org/licenses/MIT) | ||
|
|
||
| **Start developing your NPM module in seconds** ✨ | ||
| This is a mono-repo containing two packages: | ||
| ## [fluent-react-components](./packages/components) | ||
| Helper components to write cleaner jsx with fluent-react. | ||
|
|
||
| Readymade boilerplate setup with all the best practices to kick start your npm/node module development. | ||
| ## [fluent-react-extract](./packages/extraction) | ||
| CLI for extracting strings for localization into ftl files. | ||
|
|
||
| Happy hacking =) | ||
|
|
||
| # Features | ||
| # Contributing | ||
|
|
||
| * **ES6/ESNext** - Write _ES6_ code and _Babel_ will transpile it to ES5 for backwards compatibility | ||
| * **Test** - _Mocha_ with _Istanbul_ coverage | ||
| * **Lint** - Preconfigured _ESlint_ with _Airbnb_ config | ||
| * **CI** - _TravisCI_ configuration setup | ||
| * **Minify** - Built code will be minified for performance | ||
| To get started developing locally, install dependencies and build the packages using | ||
|
|
||
| # Commands | ||
| - `npm run clean` - Remove `lib/` directory | ||
| - `npm test` - Run tests with linting and coverage results. | ||
| - `npm test:only` - Run tests without linting or coverage. | ||
| - `npm test:watch` - You can even re-run tests on file changes! | ||
| - `npm test:prod` - Run tests with minified code. | ||
| - `npm run test:examples` - Test written examples on pure JS for better understanding module usage. | ||
| - `npm run lint` - Run ESlint with airbnb-config | ||
| - `npm run cover` - Get coverage report for your code. | ||
| - `npm run build` - Babel will transpile ES6 => ES5 and minify the code. | ||
| - `npm run prepublish` - Hook for npm. Do all the checks before publishing your module. | ||
|
|
||
| # Installation | ||
| Just clone this repo and remove `.git` folder. | ||
|
|
||
|
|
||
| # License | ||
|
|
||
| MIT © Dinesh Pandiyan | ||
| ``` | ||
| $ lerna bootstrap | ||
| ``` |
This file was deleted.
This file was deleted.
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| { | ||
| "packages": [ | ||
| "packages/*" | ||
| ], | ||
| "version": "0.1.2" | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| { | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Do we need to have separate
Collaborator
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
| "env": { | ||
| "development": { | ||
| "presets": ["env", "react", "es2015"], | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. shouldn't need
Collaborator
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
| "plugins": [ | ||
| "add-module-exports", | ||
| "transform-object-rest-spread" | ||
| ] | ||
| }, | ||
| "production": { | ||
| "presets": ["env", "react", "es2015", "minify"], | ||
| "plugins": [ | ||
| "add-module-exports", | ||
| "transform-object-rest-spread" | ||
| ] | ||
| } | ||
| } | ||
| } | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| { | ||
| "parser": "babel-eslint", | ||
| "extends": "airbnb", | ||
| "env": { | ||
| "mocha": true | ||
| }, | ||
| "rules": { | ||
| "comma-dangle": ["error", "only-multiline"], | ||
| "consistent-return": "off", | ||
| "import/prefer-default-export": "off", | ||
| "import/no-extraneous-dependencies": "off", | ||
| "import/no-unresolved": "off", | ||
| "import/extensions": "off", | ||
| "jsx-a11y/alt-text": "off", | ||
| "jsx-a11y/anchor-has-content": "off", | ||
| "jsx-a11y/anchor-is-valid": "off", | ||
| "jsx-a11y/heading-has-content": "off", | ||
| "no-console": "off", | ||
| "react/jsx-filename-extension": "off" | ||
| } | ||
| } |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this what we want all our work licensed under? I'm kinda curious why not MIT - though they're both very permissive
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ultimately we decided to use this because it is what the base fluent package is licensed under, and so it made sense to use the same one since they will be used together.