Merge pull request #36 from braposo/convert-to-typescript

Convert to typescript

Author: braposo

.babelrc

@@ -7,10 +7,10 @@
                 "modules": false
             }
         ],
-        "@babel/react"
+        "@babel/react",
+        "@babel/typescript"
     ],
     "plugins": [
-        "@babel/plugin-proposal-object-rest-spread",
         "@babel/plugin-proposal-class-properties"
     ],
     "env": {
@@ -20,4 +20,4 @@
             ]
         }
     }
-}
+}

.eslintrc

@@ -1,21 +1,34 @@
 {
-    "extends": "edited",
+    "extends": [
+        "airbnb-base",
+        "eslint:recommended",
+        "plugin:react/recommended",
+        "plugin:@typescript-eslint/eslint-recommended",
+        "plugin:@typescript-eslint/recommended",
+        "plugin:@typescript-eslint/recommended-requiring-type-checking",
+        "plugin:prettier/recommended",
+        "prettier/react",
+        "prettier/@typescript-eslint"
+    ],
+    "parser": "@typescript-eslint/parser",
     "parserOptions": {
-        "ecmaVersion": 6,
-        "sourceType": "module",
-        "ecmaFeatures": {
-            "jsx": true
-        }
+        "project": "./tsconfig.json"
+    },
+    "plugins": ["@typescript-eslint", "react", "prettier"],
+    "rules": {
+        "class-methods-use-this": "off",
+        "dot-notation": "off",
+        "func-names": ["error", "as-needed"],
+        "no-nested-ternary": "off"
     },
     "settings": {
+        "react": {
+            "version": "detect"
+        },
         "import/resolver": {
             "node": {
-                "extensions": [".js", ".jsx"]
+                "extensions": [".js", ".tsx", ".ts"]
             }
         }
-    },
-    "rules": {
-        "react/prefer-es6-class": [2, "always"],
-        "arrow-parens": [2, "as-needed"]
     }
 }

.gitignore

@@ -23,4 +23,6 @@ node_modules
 
 dist/
 es/
-lib/
+lib/
+examples/cache/
+examples/dist/

CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant 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 [email protected]. The project team will review and investigate all complaints, and will respond in a way that it deems 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/

CONTRIBUTING.md

@@ -15,28 +15,27 @@ Fork, then clone the repo:
 git clone https://github.com/your-username/react-text-loop.git
 ```
 
-Build package for dev mode. It will automatically watch any changes in `src/` forlder:
+Run the examples, which will automatically watch any changes in `src/` folder:
+
 ```
-yarn run dev
+yarn start
 ```
 
-We follow [eslint-config-edited](https://www.npmjs.com/package/eslint-config-edited) for code style.
-
 ### Building and testing
 
 Build package:
 ```
-yarn run build
+yarn build
 ```
 
 To run the tests:
 ```
-npm run test
+yarn test
 ```
 
 To perform linting with `eslint`, run the following:
 ```
-npm run lint
+yarn lint
 ```
 
 ### New Features

README.md

@@ -22,10 +22,14 @@ animations and spring params.
 
 [![Edit react-text-loop][codesandbox-badge]][codesandbox]
 
-### Code
+You can also run the examples by cloning the repo and running `yarn start`.
+
+### Usage
 
 ```jsx
 import TextLoop from "react-text-loop";
+import Link from "react-router";
+import { BodyText } from "./ui";
 
 class App extends Component {
     render() {
@@ -121,4 +125,4 @@ Please follow our
 [modules-badge]: https://img.shields.io/badge/module%20formats-umd%2C%20cjs%2C%20esm-green.svg?style=flat-square
 [prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square
 [codesandbox-badge]: https://codesandbox.io/static/img/play-codesandbox.svg
-[codesandbox]: https://codesandbox.io/s/github/braposo/react-text-loop/
+[codesandbox]: https://codesandbox.io/s/react-text-loop-playground-br4q1

examples/App.jsx renamed to examples/App.tsx

@@ -24,7 +24,7 @@ const StyledTextLoop = cxs(TextLoop)({
     display: "block",
 });
 
-class App extends React.PureComponent {
+class App extends React.PureComponent<{}, { options: string[]; interval: number }> {
     constructor(props) {
         super(props);
         this.state = {

examples/index.html

@@ -0,0 +1,6 @@
+<html>
+<body>
+  <div id="root"></div>
+  <script src="./index.tsx"></script>
+</body>
+</html>

index.js renamed to examples/index.tsx

@@ -1,5 +1,5 @@
 import React from "react";
 import { render } from "react-dom";
-import App from "./examples/App";
+import App from "./App";
 
 render(<App />, document.getElementById("root"));

package.json

@@ -5,17 +5,20 @@
     "main": "./lib/index.js",
     "module": "es/index.js",
     "scripts": {
-        "build": "yarn run build:commonjs && yarn run build:es && npm run build:umd && npm run build:umd:min",
-        "build:es": "babel src -d es",
-        "build:commonjs": "cross-env BABEL_ENV=commonjs babel src -d lib",
-        "build:umd": "cross-env BABEL_ENV=commonjs NODE_ENV=development webpack src/index.js -o dist/react-text-loop.js",
-        "build:umd:min": "cross-env BABEL_ENV=commonjs NODE_ENV=production webpack src/index.js -o dist/react-text-loop.min.js",
+        "build": "run-p build:commonjs build:es build:umd build:umd:min build:ts build:ts-es",
+        "build:es": "babel src -d es --extensions .ts,.tsx",
+        "build:commonjs": "cross-env BABEL_ENV=commonjs babel src -d lib --extensions .ts,.tsx",
+        "build:umd": "cross-env BABEL_ENV=commonjs NODE_ENV=development webpack src/index.ts -o dist/react-text-loop.js",
+        "build:umd:min": "cross-env BABEL_ENV=commonjs NODE_ENV=production webpack src/index.ts -o dist/react-text-loop.min.js",
+        "build:ts": "tsc",
+        "build:ts-es": "tsc -m es6 --outDir es",
         "clean": "rimraf lib dist es",
         "dev": "yarn run clean && cross-env BABEL_ENV=commonjs babel src -d lib --watch",
-        "dev:server": "webpack-dev-server ",
-        "lint": "eslint src/ --ext .js,.jsx",
+        "start": "parcel examples/index.html -d examples/dist --cache-dir examples/cache --open",
+        "lint": "eslint src/ --ext .js,.tsx,.ts",
         "prepublishOnly": "yarn run clean && yarn run build",
-        "test": "echo \"No tests available\" && exit 0"
+        "test": "echo \"No tests available\" && exit 0",
+        "ts:check": "tsc -p tsconfig.json --allowJs false --noEmit --emitDeclarationOnly false"
     },
     "repository": {
         "type": "git",
@@ -48,33 +51,46 @@
     },
     "homepage": "https://github.com/braposo/react-text-loop#readme",
     "devDependencies": {
-        "@babel/cli": "^7.2.3",
-        "@babel/core": "^7.2.2",
-        "@babel/plugin-proposal-class-properties": "^7.2.3",
-        "@babel/plugin-proposal-object-rest-spread": "^7.2.0",
-        "@babel/plugin-transform-modules-commonjs": "^7.2.0",
-        "@babel/preset-env": "^7.2.3",
+        "@babel/cli": "^7.6.0",
+        "@babel/core": "^7.6.0",
+        "@babel/plugin-proposal-class-properties": "^7.5.5",
+        "@babel/plugin-proposal-object-rest-spread": "^7.5.5",
+        "@babel/plugin-transform-modules-commonjs": "^7.6.0",
+        "@babel/preset-env": "^7.6.0",
         "@babel/preset-react": "^7.0.0",
-        "babel-eslint": "^10.0.1",
-        "babel-loader": "^8.0.4",
-        "cross-env": "^5.2.0",
-        "eslint": "^5.11.0",
-        "eslint-config-edited": "^1.0.1",
-        "eslint-plugin-import": "^2.14.0",
-        "eslint-plugin-react": "^7.11.1",
-        "react": "^16.7.0",
-        "react-dom": "^16.7.0",
-        "rimraf": "^2.6.2",
-        "webpack": "^4.28.2",
-        "webpack-cli": "^3.1.2"
+        "@babel/preset-typescript": "^7.6.0",
+        "@types/node": "^12.7.5",
+        "@types/react": "^16.9.2",
+        "@types/react-dom": "^16.9.0",
+        "@types/react-motion": "^0.0.29",
+        "@typescript-eslint/eslint-plugin": "^2.2.0",
+        "@typescript-eslint/parser": "^2.2.0",
+        "babel-eslint": "^10.0.3",
+        "babel-loader": "^8.0.6",
+        "cross-env": "^5.2.1",
+        "eslint": "^6.4.0",
+        "eslint-config-airbnb-base": "^14.0.0",
+        "eslint-config-prettier": "^6.3.0",
+        "eslint-plugin-import": "^2.18.2",
+        "eslint-plugin-prettier": "^3.1.0",
+        "eslint-plugin-react": "^7.14.3",
+        "npm-run-all": "^4.1.5",
+        "parcel-bundler": "^1.12.3",
+        "prettier": "^1.18.2",
+        "react": "^16.9.0",
+        "react-dom": "^16.9.0",
+        "rimraf": "^3.0.0",
+        "source-map-loader": "^0.2.4",
+        "typescript": "^3.6.3",
+        "webpack": "^4.40.2",
+        "webpack-cli": "^3.3.8"
     },
     "peerDependencies": {
         "react": "^15.0.1 || ^16.0.1",
         "react-dom": "^15.0.1 || ^16.0.1"
     },
     "dependencies": {
         "cxs": "^6.2.0",
-        "prop-types": "^15.6.2",
         "react-fast-compare": "2.0.4",
         "react-motion": "^0.5.2"
     }