Compare commits

..
23 Commits
Author SHA1 Message Date
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
Emin Khateeb 8b51beabd3 added transformer to readme description 2018-03-06 18:56:05 +01:00
Emin Khateeb 6fc248fe60 readme and license file are now being deleted from the setup script 2018-03-06 18:50:33 +01:00
Emin Khateeb 5629684140 now using react-native-typescript-transformer 2018-03-06 18:46:30 +01:00
Emin Khateeb fcf1ff1a6e refactored some of the descriptions to be more specific 2018-03-06 18:26:28 +01:00
Emin Khateeb 1eba8db895 minor change in contributions sentence 2018-03-06 18:15:20 +01:00
Emin Khateeb bc93c59868 added tslint as a dependency and added donations section to readme 2018-03-06 18:13:44 +01:00
Emin Khateeb bd19e744ce fixed wrong quick start guide and now also deleting flowconfig 2018-03-06 10:25:15 +01:00
Emin Khateeb 2452e06aea optimized post setup script and added state interface to App.tsx 2018-03-06 09:58:02 +01:00
Emin Khateeb 6e306bd1fd added missing deletion of the devDependencies file 2018-03-05 22:36:33 +01:00
Emin Khateeb 17487871d3 changed the way dev dependencies are being installed 2018-03-05 22:30:06 +01:00
14 changed files with 196 additions and 164 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,
},
});
+21
View File
@@ -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.
+27 -12
View File
@@ -2,33 +2,48 @@
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.
## :star: Features
- Seamless integration with the React Native CLI
- Always latest dependencies
- React Native TypeScript transformer directly integrated into the packager! (No separate process for TSC)
- Unit testing in TypeScript with Jest
## :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
## :computer: 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:
+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 />
);
});
+8 -5
View File
@@ -1,5 +1,8 @@
{
"@types/react": "16.0.40",
"@types/react-native": "0.52.16",
"typescript": "2.7.2"
}
[
"typescript",
"react-native-typescript-transformer",
"ts-jest",
"@types/react",
"@types/react-native",
"@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>",
+8
View File
@@ -0,0 +1,8 @@
module.exports = {
getTransformModulePath() {
return require.resolve('react-native-typescript-transformer');
},
getSourceExts() {
return ['ts', 'tsx'];
}
}
-35
View File
@@ -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.')
+30
View File
@@ -0,0 +1,30 @@
const fs = require('fs');
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);
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('index.js');
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('✅ Setup completed! You can now start with: npm start');
-48
View File
@@ -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,
},
});
+10 -56
View File
@@ -1,58 +1,12 @@
{
"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
},
"exclude": [
"node_modules"
]
}