Compare commits

...
5 Commits
8 changed files with 73 additions and 38 deletions

No files matched your search

-2
View File
@@ -1,3 +1 @@
.travis.yml
README.md
LICENSE
+19 -9
View File
@@ -2,9 +2,7 @@
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.
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.
## :arrow_forward: Quick Start
@@ -16,19 +14,31 @@ 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)
- [TypeScript type definitions for React & React Native](https://github.com/DefinitelyTyped/DefinitelyTyped)
- [TSLint](https://github.com/palantir/tslint)
- [TSLint React](https://github.com/palantir/tslint-react)
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.
### 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.
### What about Jest?
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).
This template does not cover Jest yet. For more info on the current status check the [open issue](https://github.com/emin93/react-native-template-typescript/issues/1).
### 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
Contributions are of course very welcome. Please try to stay consistent with the other files I've created.
Contributions are very welcome. Please try to stay consistent with the other files I've created.
### 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:
+4 -2
View File
@@ -1,6 +1,8 @@
[
"typescript",
"tslint",
"tslint-react",
"@types/react",
"@types/react-native",
"typescript",
"npm-run-all"
"react-native-typescript-transformer"
]
+8
View File
@@ -0,0 +1,8 @@
module.exports = {
getTransformModulePath() {
return require.resolve('react-native-typescript-transformer');
},
getSourceExts() {
return ['ts', 'tsx'];
}
}
+4 -3
View File
@@ -8,9 +8,8 @@ const devDependencies = require('./devDependencies.json');
const deleteFile = (fileName) => fs.unlinkSync(path.join(process.cwd(), fileName));
const writeFile = (fileName, data) => fs.writeFileSync(path.join(process.cwd(), fileName), data);
packageJson.scripts.rn = packageJson.scripts.start;
packageJson.scripts.ts = 'node_modules/.bin/tsc -w';
packageJson.scripts.start = 'npm-run-all -p -r rn ts';
packageJson.scripts.start = `${packageJson.scripts.start} --config ${path.join(process.cwd(), 'rn-cli.config.js')}`;
packageJson.scripts.lint = 'tslint -c tslint.json "src/**/*.{ts,tsx}"';
writeFile('package.json', JSON.stringify(packageJson, null, 2));
execSync(`npm i ${devDependencies.join(' ')} --save-dev --save-exact`);
@@ -18,6 +17,8 @@ execSync(`npm i ${devDependencies.join(' ')} --save-dev --save-exact`);
deleteFile('App.js');
deleteFile('.flowconfig');
deleteFile('devDependencies.json');
deleteFile('README.md');
deleteFile('LICENSE');
deleteFile('setup.js');
console.log('✅ Setup completed! You can now start with: npm start');
+24 -19
View File
@@ -1,18 +1,23 @@
import * as React from 'react';
import { Platform, StyleSheet, Text, View } from 'react-native';
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',
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 Props { }
interface State { }
interface IProps {
exampleProp: string;
}
export default class App extends React.Component<Props, State> {
render() {
interface IState {
exampleState: string;
}
export default class App extends React.Component<IProps, IState> {
public render() {
return (
<View style={styles.container}>
<Text style={styles.welcome}>
@@ -31,19 +36,19 @@ export default class App extends React.Component<Props, State> {
const styles = StyleSheet.create({
container: {
alignItems: "center",
backgroundColor: "#F5FCFF",
flex: 1,
justifyContent: 'center',
alignItems: 'center',
backgroundColor: '#F5FCFF',
justifyContent: "center",
},
instructions: {
color: "#333333",
marginBottom: 5,
textAlign: "center",
},
welcome: {
fontSize: 20,
textAlign: 'center',
margin: 10,
},
instructions: {
textAlign: 'center',
color: '#333333',
marginBottom: 5,
textAlign: "center",
},
});
+4 -3
View File
@@ -13,7 +13,7 @@
"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. */
"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'). */
@@ -34,7 +34,7 @@
// "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). */
"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. */
@@ -54,5 +54,6 @@
// "experimentalDecorators": true, /* Enables experimental support for ES7 decorators. */
// "emitDecoratorMetadata": true, /* Enables experimental support for emitting type metadata for decorators. */
},
"include": ["./src"]
"include": ["./src"],
"exclude": ["node_modules"]
}
+10
View File
@@ -0,0 +1,10 @@
{
"defaultSeverity": "error",
"extends": [
"tslint:recommended",
"tslint-react"
],
"jsRules": {},
"rules": {},
"rulesDirectory": []
}