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

Update App.tsx

.gitignore

@@ -34,10 +34,6 @@ local.properties
 #
 .vscode/
 
-# TypeScript
-#
-lib/
-
 # node.js
 #
 node_modules/

.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. 

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Emin Khateeb
+
+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:
+
+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.

README.md

@@ -2,33 +2,55 @@
 
 Clean and minimalist React Native template for a quick start with TypeScript.
 
-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.
+[![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
 
 ```
 react-native init MyApp --template typescript
 cd MyApp
-node scripts/setup.sh
+node setup.js
 ```
 
 ## :question: FAQ
 
-### Why the post install script?
+### What is included in this template?
 
-The React Native CLI currently supports automatic installation only of production dependencies. Since TypeScript type definitions are dev dependencies, the post install script is being used to install those.
+-   [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)
 
-### What about 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.
 
-Currently this template does not cover Jest. For more info on the current status check the [open issue](https://github.com/emin93/react-native-template-typescript/issues/1).
+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.
 
 ### How will this template affect the React Native CLI workflow?
 
-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.
+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 of course 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
+
+I created this project in my spare time because I enjoy coding. Of course you can support me by [buying me a coffee](https://www.paypal.me/emin93) if you wish. :coffee: :relieved:

__tests__/App.tsx

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

devDependencies.json

@@ -1,5 +1,9 @@
-{
-    "@types/react": "16.0.40",
-    "@types/react-native": "0.52.16",
-    "typescript": "2.7.2"
-}
+[
+    "@types/jest",
+    "@types/react",
+    "@types/react-native",
+    "@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 './lib/App';
-
-AppRegistry.registerComponent('HelloWorld', () => App);

jest.json

@@ -0,0 +1,15 @@
+{
+    "transform": {
+        "^.+\\.tsx?$": "ts-jest"
+    },
+    "testRegex": "(/__tests__/.*|(\\.|/)(test|spec))\\.(jsx?|tsx?)$",
+    "moduleFileExtensions": [
+        "ts",
+        "tsx",
+        "js",
+        "jsx",
+        "json",
+        "node"
+    ],
+    "modulePaths": ["<rootDir>"]
+}

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>",

rn-cli.config.js

@@ -0,0 +1,8 @@
+module.exports = {
+    getTransformModulePath() {
+        return require.resolve('react-native-typescript-transformer');
+    },
+    getSourceExts() {
+        return ['ts', 'tsx'];
+    }
+}

scripts/setup.js

@@ -1,35 +0,0 @@
-const fs = require('fs');
-const path = require('path');
-const { execSync } = require('child_process');
-
-const packageJson = require('../package.json');
-const devDependencies = require('../devDependencies.json');
-
-const isInScriptsDirectory = fs.existsSync(path.join(process.cwd(), 'install.js'));
-const pathPrefix = isInScriptsDirectory ? '../' : '';
-
-const deleteFile = (fileName) => fs.unlinkSync(path.join(process.cwd(), `${pathPrefix}${fileName}`));
-const writeFile = (fileName, data) => fs.writeFileSync(path.join(process.cwd(), `${pathPrefix}${fileName}`), data);
-
-(() => {
-    deleteFile('App.js');
-})();
-
-(() => {
-    if (!packageJson.devDependencies) {
-        packageJson.devDependencies = {};
-    }
-    packageJson.devDependencies = Object.assign(packageJson.devDependencies, devDependencies);
-
-    if (!packageJson.scripts) {
-        packageJson.scripts = {};
-    }
-    packageJson.scripts = Object.assign(packageJson.scripts, { watch: './node_modules/.bin/tsc -w' })
-
-    const data = JSON.stringify(packageJson, null, 2);
-    writeFile('package.json', data);
-    execSync('npm i');
-    deleteFile('devDependencies.json');
-})();
-
-console.log('✅ Setup completed! You can now delete the scripts folder.')

setup.js

@@ -0,0 +1,56 @@
+const fs = require('fs');
+const path = require('path');
+const { execSync } = require('child_process');
+
+const packageJson = require('./package.json');
+const jestConfig = require('./jest.json');
+const devDependencies = require('./devDependencies.json');
+
+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.jest = Object.assign(packageJson.jest, jestConfig);
+writeFile('package.json', JSON.stringify(packageJson, null, 2));
+
+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');
+deleteFile('.flowconfig');
+deleteFile('devDependencies.json');
+deleteFile('jest.json');
+deleteFile('README.md');
+deleteFile('LICENSE');
+deleteFile('setup.js');
+
+console.log(`\n✅ Setup completed! You can now start with: ${packageManager} start\n`);

src/App.tsx

@@ -1,48 +0,0 @@
-import * as React 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',
-});
-
-export interface Props { }
-
-export default class App extends React.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.js
-                </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,
-    },
-});

tsconfig.json

@@ -1,58 +1,14 @@
 {
-  "compilerOptions": {
-    /* Basic Options */
-    "target": "es6",                          /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017','ES2018' or 'ESNEXT'. */
-    "module": "commonjs",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
-    // "lib": [],                             /* Specify library files to be included in the compilation. */
-    // "allowJs": true,                       /* Allow javascript files to be compiled. */
-    // "checkJs": true,                       /* Report errors in .js files. */
-    "jsx": "react",                           /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
-    // "declaration": true,                   /* Generates corresponding '.d.ts' file. */
-    "sourceMap": true,                        /* Generates corresponding '.map' file. */
-    // "outFile": "./",                       /* Concatenate and emit output to single file. */
-    "outDir": "./lib",                        /* Redirect output structure to the directory. */
-    // "rootDir": "./",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
-    // "removeComments": true,                /* Do not emit comments to output. */
-    // "noEmit": true,                        /* Do not emit outputs. */
-    // "importHelpers": true,                 /* Import emit helpers from 'tslib'. */
-    // "downlevelIteration": true,            /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
-    // "isolatedModules": true,               /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
-
-    /* Strict Type-Checking Options */
-    "strict": true,                           /* Enable all strict type-checking options. */
-    // "noImplicitAny": true,                 /* Raise error on expressions and declarations with an implied 'any' type. */
-    // "strictNullChecks": true,              /* Enable strict null checks. */
-    // "strictFunctionTypes": true,           /* Enable strict checking of function types. */
-    // "strictPropertyInitialization": true,  /* Enable strict checking of property initialization in classes. */
-    // "noImplicitThis": true,                /* Raise error on 'this' expressions with an implied 'any' type. */
-    // "alwaysStrict": true,                  /* Parse in strict mode and emit "use strict" for each source file. */
-
-    /* Additional Checks */
-    // "noUnusedLocals": true,                /* Report errors on unused locals. */
-    // "noUnusedParameters": true,            /* Report errors on unused parameters. */
-    // "noImplicitReturns": true,             /* Report error when not all code paths in function return a value. */
-    // "noFallthroughCasesInSwitch": true,    /* Report errors for fallthrough cases in switch statement. */
-
-    /* Module Resolution Options */
-    // "moduleResolution": "node",            /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
-    // "baseUrl": "./",                       /* Base directory to resolve non-absolute module names. */
-    // "paths": {},                           /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
-    // "rootDirs": [],                        /* List of root folders whose combined content represents the structure of the project at runtime. */
-    // "typeRoots": [],                       /* List of folders to include type definitions from. */
-    // "types": [],                           /* Type declaration files to be included in compilation. */
-    // "allowSyntheticDefaultImports": true,  /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
-    "esModuleInterop": true                   /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
-    // "preserveSymlinks": true,              /* Do not resolve the real path of symlinks. */
-
-    /* Source Map Options */
-    // "sourceRoot": "./",                    /* Specify the location where debugger should locate TypeScript files instead of source locations. */
-    // "mapRoot": "./",                       /* Specify the location where debugger should locate map files instead of generated locations. */
-    // "inlineSourceMap": true,               /* Emit a single file with source maps instead of having a separate file. */
-    // "inlineSources": true,                 /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
-
-    /* Experimental Options */
-    // "experimentalDecorators": true,        /* Enables experimental support for ES7 decorators. */
-    // "emitDecoratorMetadata": true,         /* Enables experimental support for emitting type metadata for decorators. */
-  },
-  "include": ["./src"]
+    "compilerOptions": {
+        "target": "es2015",
+        "jsx": "react",
+        "noEmit": true,
+        "moduleResolution": "node",
+        "noImplicitAny": true,
+        "allowSyntheticDefaultImports": true,
+        "esModuleInterop": true
+    },
+    "exclude": [
+        "node_modules"
+    ]
 }