Compare commits

..
16 Commits
Author SHA1 Message Date
Emin Khateeb 3f295f24b9 removed delete of the index.js 2018-03-21 11:05:13 +01:00
Emin Khateeb 166dd361d2 improved feature section in readme 2018-03-21 11:04:20 +01:00
Emin Khateeb 2139753b44 fixed error which caused the app load to fail 2018-03-21 10:59:59 +01:00
Emin Khateeb ea1c65e260 now also removing index.js in the setup script 2018-03-21 10:40:22 +01:00
Emin Khateeb e4eca8679a removed tslint for more consistency with the default RN template 2018-03-21 10:39:36 +01:00
Emin Khateeb 79b0923763 Revert "moved setup file to a separate package"
This reverts commit 4c306c4fbf.
2018-03-10 20:25:43 +01:00
Emin Khateeb 4c306c4fbf moved setup file to a separate package 2018-03-10 20:07:52 +01:00
Emin Khateeb ee9d44e70d added new keywords 2018-03-07 22:07:48 +01:00
Emin Khateeb 0f5dc1d0f5 added please wait log to the setup script 2018-03-07 22:00:53 +01:00
Emin Khateeb 289a767088 added credits to the contributors and maintainers of the packages used in this template 2018-03-07 21:27:02 +01:00
Emin Khateeb af15e006c1 typescript jest files are now working 2018-03-06 22:55:43 +01:00
Emin Khateeb 010c267dfe changed indentation style on tsconfig 2018-03-06 22:24:38 +01:00
Emin Khateeb 184b3e3963 added jest dependencies 2018-03-06 22:14:06 +01:00
Emin Khateeb e0c02f0427 fixed issue with npm start failing 2018-03-06 21:59:05 +01:00
Emin Khateeb 901e2315e6 minor refactoring in readme 2018-03-06 21:58:55 +01:00
Emin Khateeb 87e29d3d66 minor refactoring 2018-03-06 19:06:03 +01:00
12 changed files with 126 additions and 95 deletions

No files matched your search

-4
View File
@@ -34,10 +34,6 @@ local.properties
#
.vscode/
# TypeScript
#
lib/
# node.js
#
node_modules/
+60
View File
@@ -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 * 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',
});
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.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,
},
});
+14 -9
View File
@@ -4,6 +4,14 @@ 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.
## :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
```
@@ -17,26 +25,23 @@ node setup.js
### What is included in this template?
- [TypeScript](https://github.com/Microsoft/TypeScript)
- [TypeScript type definitions for React & React Native](https://github.com/DefinitelyTyped/DefinitelyTyped)
- [react-native-typescript-transformer](https://github.com/ds300/react-native-typescript-transformer)
- [TSLint](https://github.com/palantir/tslint)
- [TSLint React](https://github.com/palantir/tslint-react)
- [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.
### What about Jest?
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.
## :hearts: Contributing
## :computer: Contributing
Contributions are very welcome. Please try to stay consistent with the other files I've created.
+12
View File
@@ -0,0 +1,12 @@
import 'react-native';
import * as React from 'react';
import App from '../App';
// Note: test renderer must be required after react-native.
import * as renderer from 'react-test-renderer';
it('renders correctly', () => {
const tree = renderer.create(
<App />
);
});
+3 -3
View File
@@ -1,8 +1,8 @@
[
"typescript",
"tslint",
"tslint-react",
"react-native-typescript-transformer",
"ts-jest",
"@types/react",
"@types/react-native",
"react-native-typescript-transformer"
"@types/jest"
]
+1 -1
View File
@@ -1,4 +1,4 @@
import { AppRegistry } from 'react-native';
import App from './lib/App';
import App from './App';
AppRegistry.registerComponent('HelloWorld', () => App);
+15
View File
@@ -0,0 +1,15 @@
{
"transform": {
"^.+\\.tsx?$": "ts-jest"
},
"testRegex": "(/__tests__/.*|(\\.|/)(test|spec))\\.(jsx?|tsx?)$",
"moduleFileExtensions": [
"ts",
"tsx",
"js",
"jsx",
"json",
"node"
],
"modulePaths": ["<rootDir>"]
}
+4 -3
View File
@@ -10,10 +10,11 @@
"url": "git+https://github.com/emin93/react-native-template-typescript.git"
},
"keywords": [
"react",
"native",
"template",
"react-native",
"typescript",
"tslint",
"jest",
"template",
"boilerplate"
],
"author": "Emin Khateeb <emin@emin.ch>",
+7 -2
View File
@@ -3,20 +3,25 @@ const path = require('path');
const { execSync } = require('child_process');
const packageJson = require('./package.json');
const jestJson = require('./jest.json');
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.start = `${packageJson.scripts.start} --config ${path.join(process.cwd(), 'rn-cli.config.js')}`;
packageJson.scripts.lint = 'tslint -c tslint.json "src/**/*.{ts,tsx}"';
console.log('🔄 Please wait...');
packageJson.scripts.start = `${packageJson.scripts.start} --config ../../../../rn-cli.config.js`;
packageJson.jest = Object.assign(packageJson.jest, jestJson);
writeFile('package.json', JSON.stringify(packageJson, null, 2));
execSync(`npm i ${devDependencies.join(' ')} --save-dev --save-exact`);
deleteFile('App.js');
deleteFile('__tests__/App.js');
deleteFile('.flowconfig');
deleteFile('devDependencies.json');
deleteFile('jest.json');
deleteFile('README.md');
deleteFile('LICENSE');
deleteFile('setup.js');
-54
View File
@@ -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",
},
});
+10 -9
View File
@@ -1,11 +1,12 @@
{
"compilerOptions": {
"target": "es2015",
"jsx": "react",
"noEmit": true,
"moduleResolution": "node",
},
"exclude": [
"node_modules"
]
"compilerOptions": {
"target": "es2015",
"jsx": "react",
"noEmit": true,
"moduleResolution": "node",
"noImplicitAny": true
},
"exclude": [
"node_modules"
]
}
-10
View File
@@ -1,10 +0,0 @@
{
"defaultSeverity": "error",
"extends": [
"tslint:recommended",
"tslint-react"
],
"jsRules": {},
"rules": {},
"rulesDirectory": []
}