Compare commits

..
64 Commits
Author SHA1 Message Date
Emin Khateeb 10fac6c22f Update tsconfig.json
reverted wrong react jsx mode
2018-07-03 11:24:48 +02:00
Emin Khateeb 172b32155d Update tsconfig.json
addressed issue (https://github.com/emin93/react-native-template-typescript/issues/17) which caused typescript to fail compilation of a newly created project
2018-07-03 11:24:03 +02:00
Emin Khateeb 2d7334d61e setup can now be done with a single line command 2018-06-14 12:51:19 +02:00
Emin Khateeb caae886d8f setup script is now working dir independent 2018-06-14 12:25:57 +02:00
Emin Khateeb 270f516448 Update setup.js
now also deleting devDependencies.json after the setup
2018-06-14 11:04:23 +02:00
Emin Khateeb 8ed8b19828 fixed delete method 2018-06-14 10:06:43 +02:00
Emin Khateeb c66f735c19 removed deletes of non-existing files 2018-06-14 10:05:17 +02:00
Emin Khateeb b2f6208cb4 minor wording change 2018-06-14 08:36:41 +02:00
Emin Khateeb 3b10c51f74 removed npm version badge 2018-06-13 20:48:01 +02:00
Emin Khateeb 8d885ab3f5 Simplified README.md 2018-06-13 19:35:56 +02:00
Emin Khateeb b937346ac2 Merge pull request #16 from emin93/rn-0.56
RN 0.56 support
2018-06-13 18:44:26 +02:00
Emin Khateeb cd047d58f0 added link to Albert Gao's article 2018-06-13 18:32:35 +02:00
Emin Khateeb 6a8da82688 added demonstration of working breakpoints 2018-06-13 18:16:16 +02:00
Emin Khateeb ac23b8ac83 removed tests directory to be more consistent with the latest rn 2018-06-13 18:04:48 +02:00
Emin Khateeb 987fe89238 removed reference to package manager 2018-06-13 17:52:27 +02:00
Emin Khateeb 5361316879 prepared compatibility with React Native 0.56 2018-06-13 17:33:22 +02:00
Emin Khateeb c11df248ab changed jsx mode to react-native 2018-06-13 17:17:27 +02:00
Emin Khateeb ec3a826edc Update README.md
added new solution for debugging
2018-06-06 17:28:42 +02:00
Emin Khateeb a585faa237 Update tsconfig.json
re-ordered members alphabetically and added module option
2018-06-06 17:09:01 +02:00
Emin Khateeb 919ebb922e Update setup.js
removed start script config parameter as it seems to work just fine without
2018-06-06 17:05:20 +02:00
Emin Khateeb 57233a492b fixed issue with new deployment 2018-04-24 21:25:57 +02:00
Emin Khateeb b8f4b89aca now caching node modules 2018-04-24 21:18:36 +02:00
Emin Khateeb 80e970bda8 added standardjs to lint the setup.js and now using consistently 2 spaces indent 2018-04-24 21:14:46 +02:00
Emin Khateeb dc432eea2d Update App.tsx
removed unnecessary semicolon
2018-04-20 11:34:35 +02:00
Emin Khateeb 8c5248b2b3 Merge pull request #15 from emin93/emin93-patch-1
Update README.md
2018-04-10 15:29:42 +02:00
Emin Khateeb 11fa0420ed Update README.md
added link to vs code debugging fix
2018-04-10 15:29:12 +02:00
Emin Khateeb d885abb7ce Merge pull request #14 from emin93/emin93-patch-1
Update App.tsx
2018-04-10 13:12:36 +02:00
Emin Khateeb fbe903ad81 Update App.tsx 2018-04-10 13:09:24 +02:00
Emin Khateeb eff79f6d54 Merge pull request #12 from emin93/emin93-patch-1
Update setup.js
2018-04-10 12:18:34 +02:00
Emin Khateeb d3f6c2e173 Update setup.js
Fixed issue which caused the setup script when trying to delete non-existing files.
2018-04-10 12:17:03 +02:00
Emin Khateeb 418f04b312 Merge pull request #11 from TimeWarpEngineering/master
Enable esModuleInterop
2018-04-01 11:20:26 +02:00
Steven Cramer 126df709d6 Update import in test
Update the import in __tests__\App.tsx to align with react-native
2018-04-01 16:15:57 +07:00
Steven Cramer 590b9f8326 Update to Standard React Native Template import
react-native default template uses import React from 'react' and this is now supported the the allowSyntheticDefaultImports enabled.
2018-04-01 14:53:51 +07:00
Steven Cramer 7b686518ed Allow esModuleInterop
Allow default imports from modules with no default export. This does not affect code emit, just typechecking.
Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports.
2018-04-01 14:52:23 +07:00
Steven Cramer 491b0caf18 sort dependencies
Lets keep these sorted so easier to find and see differences.
2018-04-01 14:50:39 +07:00
Steven T. Cramer 393523caa6 Merge pull request #1 from emin93/master
Merge pull request #10 from TimeWarpEngineering/master
2018-04-01 14:44:13 +07:00
Emin Khateeb 50f58b7023 Merge pull request #10 from TimeWarpEngineering/master
Add @types/react-test-renderer
2018-04-01 09:29:36 +02:00
Steven T. Cramer 19afb6b08a Add @types/react-test-renderer 2018-04-01 10:42:07 +07:00
Emin Khateeb 587a21df1e added issue template to npm ignore 2018-03-28 20:30:57 +02:00
Emin Khateeb 9f15bca7e9 Create ISSUE_TEMPLATE.md 2018-03-28 20:29:37 +02:00
Emin Khateeb 0af9bb62de added contribution document reference in readme 2018-03-28 20:25:59 +02:00
Emin Khateeb a9fcdbe72a Merge pull request #9 from emin93/remove-contribution-npm
added code of conduct and contribution guide to the npmignore
2018-03-28 20:21:35 +02:00
Emin Khateeb 7ce6851ea7 added code of conduct and contribution guide to the npmignore 2018-03-28 20:18:21 +02:00
Emin Khateeb 51a72a0641 Merge pull request #8 from emin93/add-contribution-guideline
added a contribution guideline
2018-03-28 16:53:43 +02:00
Emin Khateeb e9b8569636 added a contribution guideline 2018-03-28 16:52:43 +02:00
Emin Khateeb cb4fc02d4c Merge pull request #7 from emin93/add-code-of-conduct-1
Create CODE_OF_CONDUCT.md
2018-03-28 15:59:52 +02:00
Emin Khateeb 30d3b114fb Create CODE_OF_CONDUCT.md 2018-03-28 15:58:19 +02:00
Emin Khateeb 9bb1823d8e preparations to support other package managers as well 2018-03-28 15:44:35 +02:00
Emin Khateeb 302409b2aa fixed issue which caused always using yarn as the packager 2018-03-28 11:27:01 +02:00
Emin Khateeb 81d1c898df Merge pull request #5 from oieduardorabelo/master
[feat] add support for Yarn + inheriting exec process
2018-03-28 11:17:28 +02:00
Eduardo Rabelo ecd2665a7c fix: tidy up, moving fns to top, etc 2018-03-28 19:54:40 +13:00
Eduardo Rabelo ea53a939b8 feat: line space + stdio options 2018-03-28 19:48:30 +13:00
Eduardo Rabelo ef94173200 feat: add log message for install step 2018-03-28 19:43:51 +13:00
Eduardo Rabelo fe8abb8848 feat: add support for yarn 2018-03-28 19:39:25 +13:00
Emin Khateeb 8e8013e835 added links section to readme 2018-03-27 13:02:14 +02:00
Emin Khateeb b80fb5d42b added link to the article on medium 2018-03-27 12:45:45 +02:00
Emin Khateeb 59bf3c6fc3 removed index.js since this is included in the default rn template 2018-03-21 11:22:35 +01:00
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
18 changed files with 2150 additions and 181 deletions

No files matched your search

+3
View File
@@ -1 +1,4 @@
.travis.yml
CODE_OF_CONDUCT.md
CONTRIBUTING.md
ISSUE_TEMPLATE.md
+3 -1
View File
@@ -1,7 +1,9 @@
language: node_js
node_js:
- "node"
install: true
cache:
directories:
- "node_modules"
deploy:
on:
tags: true
+51
View File
@@ -0,0 +1,51 @@
/**
* Sample React Native App
* https://github.com/facebook/react-native
*
* Generated with the TypeScript template
* https://github.com/emin93/react-native-template-typescript
*
* @format
*/
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,
},
});
+46
View File
@@ -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/
+21
View File
@@ -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.
+15
View File
@@ -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.
+27 -16
View File
@@ -1,43 +1,54 @@
# :space_invader: React Native Template TypeScript · [![npm](https://img.shields.io/npm/v/react-native-template-typescript.svg)](https://www.npmjs.com/package/react-native-template-typescript) [![Travis](https://img.shields.io/travis/emin93/react-native-template-typescript.svg)](https://travis-ci.org/emin93/react-native-template-typescript)
# :space_invader: React Native Template TypeScript · [![Build Status](https://travis-ci.org/emin93/react-native-template-typescript.svg?branch=master)](https://travis-ci.org/emin93/react-native-template-typescript)
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)
## :star: Features
- Seamlessly integrated into the React Native CLI! :sparkles:
- Consistent with the default React Native template
- React Native TypeScript Transformer included
- 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 setup.js
```bash
react-native init MyApp --template typescript && node MyApp/setup.js
```
## :question: FAQ
### What is included in this template?
### What's included in this template?
- [TypeScript](https://github.com/Microsoft/TypeScript)
- [React Native TypeScript transformer](https://github.com/ds300/react-native-typescript-transformer)
- [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)
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.
This template always uses the latest versions of the dependencies at the time when the `react-native init` command 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.
It deletes obsolete files like the `.flowconfig` and the `setup.js` itself after the setup.
### How will this template affect the React Native CLI workflow?
### Does debugging work?
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.
Yes it does.
## :hearts: Contributing
[![Demonstration of working breakpoints in Visual Studio Code](https://cdn-images-1.medium.com/max/1600/1*ZXfzgq1xKz1B3chYy9xE7w.png)](https://medium.com/@emin93/react-native-typescript-b965059109d3)
Contributions are very welcome. Please try to stay consistent with the other files I've created.
## :globe_with_meridians: Links
- ["Using React Native with TypeScript just became simple" on Medium](https://medium.com/@emin93/react-native-typescript-b965059109d3)
- ["24 tips for React Native you probably want to know" on Albert Gao's blog](http://albertgao.xyz/2018/05/30/24-tips-for-react-native-you-probably-want-to-know/#9-For-Typescript)
## :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
-9
View File
@@ -1,9 +0,0 @@
import * as React from "react";
import "react-native";
import { create } from "react-test-renderer";
import App from "../src/App";
it("renders correctly", () => {
const tree = create(<App exampleProp="helloWorld" />);
});
+9 -10
View File
@@ -1,10 +1,9 @@
[
"typescript",
"tslint",
"tslint-react",
"react-native-typescript-transformer",
"ts-jest",
"@types/react",
"@types/react-native",
"@types/jest"
]
{
"@types/jest": "latest",
"@types/react-native": "latest",
"@types/react-test-renderer": "latest",
"@types/react": "latest",
"react-native-typescript-transformer": "latest",
"ts-jest": "latest",
"typescript": "latest"
}
-4
View File
@@ -1,4 +0,0 @@
import { AppRegistry } from 'react-native';
import App from './src/App';
AppRegistry.registerComponent('HelloWorld', () => App);
+13 -13
View File
@@ -1,15 +1,15 @@
{
"transform": {
"^.+\\.tsx?$": "ts-jest"
},
"testRegex": "(/__tests__/.*|(\\.|/)(test|spec))\\.(jsx?|tsx?)$",
"moduleFileExtensions": [
"ts",
"tsx",
"js",
"jsx",
"json",
"node"
],
"modulePaths": ["<rootDir>"]
"transform": {
"^.+\\.tsx?$": "ts-jest"
},
"testRegex": "(/__tests__/.*|(\\.|/)(test|spec))\\.(jsx?|tsx?)$",
"moduleFileExtensions": [
"ts",
"tsx",
"js",
"jsx",
"json",
"node"
],
"modulePaths": ["<rootDir>"]
}
+1899
View File
File diff suppressed because it is too large. Load diff
+27 -24
View File
@@ -1,26 +1,29 @@
{
"name": "react-native-template-typescript",
"version": "0.0.1",
"description": "Clean and minimalist React Native template for a quick start with TypeScript.",
"scripts": {
"prepublishOnly": "npm --no-git-tag-version version from-git"
},
"repository": {
"type": "git",
"url": "git+https://github.com/emin93/react-native-template-typescript.git"
},
"keywords": [
"react-native",
"typescript",
"tslint",
"jest",
"template",
"boilerplate"
],
"author": "Emin Khateeb <emin@emin.ch>",
"license": "MIT",
"bugs": {
"url": "https://github.com/emin93/react-native-template-typescript/issues"
},
"homepage": "https://github.com/emin93/react-native-template-typescript#readme"
"name": "react-native-template-typescript",
"version": "0.0.1",
"description": "Clean and minimalist React Native template for a quick start with TypeScript.",
"scripts": {
"test": "standard setup.js",
"prepublishOnly": "git reset --hard && npm --no-git-tag-version version from-git"
},
"repository": {
"type": "git",
"url": "git+https://github.com/emin93/react-native-template-typescript.git"
},
"keywords": [
"react-native",
"typescript",
"jest",
"template",
"boilerplate"
],
"author": "Emin Khateeb <emin@emin.ch>",
"license": "MIT",
"bugs": {
"url": "https://github.com/emin93/react-native-template-typescript/issues"
},
"homepage": "https://github.com/emin93/react-native-template-typescript#readme",
"devDependencies": {
"standard": "11.0.1"
}
}
+7 -7
View File
@@ -1,8 +1,8 @@
module.exports = {
getTransformModulePath() {
return require.resolve('react-native-typescript-transformer');
},
getSourceExts() {
return ['ts', 'tsx'];
}
}
getTransformModulePath() {
return require.resolve('react-native-typescript-transformer');
},
getSourceExts() {
return ['ts', 'tsx'];
},
};
+17 -24
View File
@@ -1,30 +1,23 @@
const fs = require('fs');
const path = require('path');
const { execSync } = require('child_process');
const fs = require('fs')
const path = require('path')
const packageJson = require('./package.json');
const jestJson = require('./jest.json');
const devDependencies = require('./devDependencies.json');
const packageJson = require('./package.json')
const jestConfig = require('./jest.json')
const deleteFile = (fileName) => fs.unlinkSync(path.join(process.cwd(), fileName));
const writeFile = (fileName, data) => fs.writeFileSync(path.join(process.cwd(), fileName), data);
const deleteFile = (fileName) => fs.unlinkSync(path.join(__dirname, fileName))
const writeFile = (fileName, data) => fs.writeFileSync(path.join(__dirname, fileName), data)
console.log('🔄 Please wait...');
console.log('🔄 Setting up...')
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);
writeFile('package.json', JSON.stringify(packageJson, null, 2));
packageJson.jest = Object.assign(packageJson.jest, jestConfig)
writeFile('package.json', JSON.stringify(packageJson, null, 2))
execSync(`npm i ${devDependencies.join(' ')} --save-dev --save-exact`);
deleteFile('.flowconfig')
deleteFile('App.js')
deleteFile('devDependencies.json')
deleteFile('jest.json')
deleteFile('LICENSE')
deleteFile('README.md')
deleteFile('setup.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');
console.log(`✅ Setup completed!`)
-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",
},
});
+12 -9
View File
@@ -1,11 +1,14 @@
{
"compilerOptions": {
"target": "es2015",
"jsx": "react",
"noEmit": true,
"moduleResolution": "node",
},
"exclude": [
"node_modules"
]
"compilerOptions": {
"allowSyntheticDefaultImports": true,
"esModuleInterop": true,
"jsx": "react-native",
"lib": ["es6"],
"module": "es6",
"moduleResolution": "node",
"noEmit": true,
"noImplicitAny": true,
"target": "es6"
},
"exclude": ["node_modules"]
}
-10
View File
@@ -1,10 +0,0 @@
{
"defaultSeverity": "error",
"extends": [
"tslint:recommended",
"tslint-react"
],
"jsRules": {},
"rules": {},
"rulesDirectory": []
}