Merge pull request #14 from emin93/emin93-patch-1

Update App.tsx

.npmignore

@@ -1 +1,4 @@
 .travis.yml
+CODE_OF_CONDUCT.md
+CONTRIBUTING.md
+ISSUE_TEMPLATE.md

App.tsx

@@ -0,0 +1,60 @@
+/**
+ * Sample React Native App
+ * https://github.com/facebook/react-native
+ * 
+ * Generated with the TypeScript template
+ * https://github.com/emin93/react-native-template-typescript
+ */
+
+import React, { Component } from 'react';
+import {
+  Platform,
+  StyleSheet,
+  Text,
+  View
+} from 'react-native';
+
+const instructions = Platform.select({
+  ios: 'Press Cmd+R to reload,\n' +
+    'Cmd+D or shake for dev menu',
+  android: 'Double tap R on your keyboard to reload,\n' +
+    'Shake or press menu button for dev menu',
+});
+
+interface Props {};
+export default class App extends Component<Props> {
+  render() {
+    return (
+      <View style={styles.container}>
+        <Text style={styles.welcome}>
+          Welcome to React Native!
+        </Text>
+        <Text style={styles.instructions}>
+          To get started, edit App.tsx
+        </Text>
+        <Text style={styles.instructions}>
+          {instructions}
+        </Text>
+      </View>
+    );
+  }
+}
+
+const styles = StyleSheet.create({
+  container: {
+    flex: 1,
+    justifyContent: 'center',
+    alignItems: 'center',
+    backgroundColor: '#F5FCFF',
+  },
+  welcome: {
+    fontSize: 20,
+    textAlign: 'center',
+    margin: 10,
+  },
+  instructions: {
+    textAlign: 'center',
+    color: '#333333',
+    marginBottom: 5,
+  },
+});

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 owner at emin@emin.ch. The project owner will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project owner 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

@@ -0,0 +1,21 @@
+# Contributing
+
+Cool, I'm glad you decided to contribute to React Native Template TypeScript.
+
+Don't worry, I won't bother you with thousands of rules. I want to make contributing to this project as easy and transparent as possible.
+
+## Workflow
+
+We use [GitHub Flow](https://guides.github.com/introduction/flow/), so all code changes happen through pull requests.
+
+1.  Fork the repository and create your branch from `master`.
+2.  If you've changed the functionality, update the documentation.
+3.  Issue that pull request! :tada:
+
+## License
+
+By contributing, you agree that your contributions will be licensed under the [MIT License](https://choosealicense.com/licenses/mit/).
+
+## Code style
+
+Currently there is no lint configuration, but you should try to stay consistent with the existing code.

ISSUE_TEMPLATE.md

@@ -0,0 +1,15 @@
+## Expected results
+
+What did you expect to happen?
+
+## Observed results
+
+What happened?
+
+### Logs
+
+Please add the log output here.
+
+## Steps to reproduce
+
+1. 

README.md

@@ -2,8 +2,18 @@
 
 Clean and minimalist React Native template for a quick start with TypeScript.
 
+[![Header](https://cdn-images-1.medium.com/max/500/1*E9RnPOATuhjuNrlFkv5oSg.jpeg)](https://medium.com/@emin93/react-native-typescript-b965059109d3)
+
 This template can be used with the React Native CLI, which means it doesn't mess with the platform specific files. Instead of including a lot of dependencies, my aim when creating this template was to provide a very easy and minimalist way to start your React Native project with TypeScript. Of course you can always include other dependencies as you need them.
 
+## :star: Features
+
+-   Seamless integration with the React Native CLI! :sparkles:
+-   Consistent with the default React Native template (no additional stuff)
+-   React Native TypeScript transformer directly integrated into the packager (no separate process for `tsc`)
+-   Unit testing in TypeScript with TS Jest
+-   Always latest dependencies :raised_hands:
+
 ## :arrow_forward: Quick Start
 
 ```
@@ -16,15 +26,15 @@ node setup.js
 
 ### What is included in this template?
 
-- [TypeScript](https://github.com/Microsoft/TypeScript)
-- [React Native TypeScript Transformer](https://github.com/ds300/react-native-typescript-transformer)
-- [Type definitions for React & React Native](https://github.com/DefinitelyTyped/DefinitelyTyped)
-- [TS Jest](https://github.com/kulshekhar/ts-jest)
-- [TSLint](https://github.com/palantir/tslint)
-- [TSLint React](https://github.com/palantir/tslint-react)
+-   [TypeScript](https://github.com/Microsoft/TypeScript)
+-   [React Native TypeScript transformer](https://github.com/ds300/react-native-typescript-transformer)
+-   [Type definitions for React & React Native](https://github.com/DefinitelyTyped/DefinitelyTyped)
+-   [TS Jest](https://github.com/kulshekhar/ts-jest)
 
 This template always uses the latest versions of the dependencies at the time when the setup script (`node setup.js`) is being executed. This means you don't have to worry about old versions.
 
+Lots of :heart: and credits to the owners and maintainers of those packages.
+
 ### Why the setup script?
 
 The React Native CLI supports automatic installation of production dependencies only. Since TypeScript and the other dependencies are dev dependencies, the setup script is being used to install those. It also takes care of obsolete files like the `.flowconfig` and the `setup.js` itself after the setup.
@@ -33,9 +43,13 @@ The React Native CLI supports automatic installation of production dependencies
 
 The React Native CLI will do everything just as without a template and afterwards overwrite the files with the ones from this template. This means you don't have to worry about incompatibility issues with later React Native upgrades.
 
-## :hearts: Contributing
+## :globe_with_meridians: Links
 
-Contributions are very welcome. Please try to stay consistent with the other files I've created.
+-   ["Using React Native with TypeScript just became simple" on Medium](https://medium.com/@emin93/react-native-typescript-b965059109d3)
+
+## :computer: Contributing
+
+Contributions are very welcome. Please check out the [contributing document](https://github.com/emin93/react-native-template-typescript/blob/master/CONTRIBUTING.md).
 
 ### Donations
 

__tests__/App.tsx

@@ -1,9 +1,12 @@
-import * as React from "react";
-import "react-native";
-import { create } from "react-test-renderer";
+import 'react-native';
+import React from 'react';
+import App from '../App';
 
-import App from "../src/App";
+// Note: test renderer must be required after react-native.
+import renderer from 'react-test-renderer';
 
-it("renders correctly", () => {
-    const tree = create(<App exampleProp="helloWorld" />);
+it('renders correctly', () => {
+  const tree = renderer.create(
+    <App />
+  );
 });

devDependencies.json

@@ -1,10 +1,9 @@
 [
-    "typescript",
-    "tslint",
-    "tslint-react",
-    "react-native-typescript-transformer",
-    "ts-jest",
+    "@types/jest",
     "@types/react",
     "@types/react-native",
-    "@types/jest"
+    "@types/react-test-renderer",
+    "react-native-typescript-transformer",
+    "ts-jest",
+    "typescript"
 ]

index.js

@@ -1,4 +0,0 @@
-import { AppRegistry } from 'react-native';
-import App from './src/App';
-
-AppRegistry.registerComponent('HelloWorld', () => App);

package.json

@@ -10,10 +10,10 @@
         "url": "git+https://github.com/emin93/react-native-template-typescript.git"
     },
     "keywords": [
-        "react",
-        "native",
-        "template",
+        "react-native",
         "typescript",
+        "jest",
+        "template",
         "boilerplate"
     ],
     "author": "Emin Khateeb <emin@emin.ch>",

setup.js

@@ -3,18 +3,46 @@ const path = require('path');
 const { execSync } = require('child_process');
 
 const packageJson = require('./package.json');
-const jestJson = require('./jest.json');
+const jestConfig = require('./jest.json');
 const devDependencies = require('./devDependencies.json');
 
-const deleteFile = (fileName) => fs.unlinkSync(path.join(process.cwd(), fileName));
+const deleteFile = (fileName) => {
+    const filePath = path.join(process.cwd(), fileName);
+
+    if (!fs.existsSync(filePath)) {
+        return;
+    }
+
+    fs.unlinkSync(filePath);
+};
 const writeFile = (fileName, data) => fs.writeFileSync(path.join(process.cwd(), fileName), data);
+const isYarnAvailable = () => {
+    try {
+        execSync('yarn --version', { stdio: 'ignore' });
+        return true;
+    } catch (exc) {
+        return false;
+    }
+};
+
+const packageManager = isYarnAvailable() ? 'yarn' : 'npm';
+const execOptions = { stdio: 'inherit' };
+
+console.log('🔄 Please wait...\n');
 
 packageJson.scripts.start = `${packageJson.scripts.start} --config ../../../../rn-cli.config.js`;
-packageJson.scripts.lint = 'tslint -c tslint.json "src/**/*.{ts,tsx}"';
-packageJson.jest = Object.assign(packageJson.jest, jestJson);
+packageJson.jest = Object.assign(packageJson.jest, jestConfig);
 writeFile('package.json', JSON.stringify(packageJson, null, 2));
 
-execSync(`npm i ${devDependencies.join(' ')} --save-dev --save-exact`);
+console.log(`📦 Installing dependencies with ${packageManager}...\n`);
+
+switch (packageManager) {
+    case 'yarn':
+        execSync(`yarn add ${devDependencies.join(' ')} --dev --exact`, execOptions);
+        break;
+    default:
+        execSync(`npm i ${devDependencies.join(' ')} --save-dev --save-exact`, execOptions);
+}
 
 deleteFile('App.js');
 deleteFile('__tests__/App.js');
@@ -25,4 +53,4 @@ deleteFile('README.md');
 deleteFile('LICENSE');
 deleteFile('setup.js');
 
-console.log('✅ Setup completed! You can now start with: npm start');
+console.log(`\n✅ Setup completed! You can now start with: ${packageManager} start\n`);

src/App.tsx

@@ -1,54 +0,0 @@
-import * as React from "react";
-import { Platform, StyleSheet, Text, View } from "react-native";
-
-const instructions = Platform.select({
-    android: "Double tap R on your keyboard to reload,\n" +
-        "Shake or press menu button for dev menu",
-    ios: "Press Cmd+R to reload,\n" +
-        "Cmd+D or shake for dev menu",
-});
-
-interface IProps {
-    exampleProp: string;
-}
-
-interface IState {
-    exampleState: string;
-}
-
-export default class App extends React.Component<IProps, IState> {
-    public render() {
-        return (
-            <View style={styles.container}>
-                <Text style={styles.welcome}>
-                    Welcome to React Native!
-                </Text>
-                <Text style={styles.instructions}>
-                    To get started, edit src/App.tsx
-                </Text>
-                <Text style={styles.instructions}>
-                    {instructions}
-                </Text>
-            </View>
-        );
-    }
-}
-
-const styles = StyleSheet.create({
-    container: {
-        alignItems: "center",
-        backgroundColor: "#F5FCFF",
-        flex: 1,
-        justifyContent: "center",
-    },
-    instructions: {
-        color: "#333333",
-        marginBottom: 5,
-        textAlign: "center",
-    },
-    welcome: {
-        fontSize: 20,
-        margin: 10,
-        textAlign: "center",
-    },
-});

tsconfig.json

@@ -4,6 +4,9 @@
         "jsx": "react",
         "noEmit": true,
         "moduleResolution": "node",
+        "noImplicitAny": true,
+        "allowSyntheticDefaultImports": true,
+        "esModuleInterop": true
     },
     "exclude": [
         "node_modules"

tslint.json

@@ -1,10 +0,0 @@
-{
-    "defaultSeverity": "error",
-    "extends": [
-        "tslint:recommended",
-        "tslint-react"
-    ],
-    "jsRules": {},
-    "rules": {},
-    "rulesDirectory": []
-}