status-im
/
metro
mirror of https://github.com/status-im/metro.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Improve JS code legibility by highlighting syntax in readme 

Summary:
**Summary**

I started reading the readme and felt this needed to be done. So I did it 😄
Closes https://github.com/facebook/metro-bundler/pull/75

Differential Revision: D6051094

Pulled By: mjesun

fbshipit-source-id: 373bb58844f36141197625286eb3684eb2de1b1c
This commit is contained in:
Franco Correa 2017-10-13 07:02:00 -07:00 committed by Facebook Github Bot
parent 55a22d2c5c
commit 4903fc6a04
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -15,7 +15,7 @@ This project was previously part of the [react-native](https://github.com/facebo
Right now, Metro Bundler cannot run by itself. Instead, some functions are exposed so that the configuration can be passed into it. First, require the module by doing: Right now, Metro Bundler cannot run by itself. Instead, some functions are exposed so that the configuration can be passed into it. First, require the module by doing:
``` ```js
const metroBundler = require('metro-bundler'); const metroBundler = require('metro-bundler');
``` ```
@ -26,7 +26,7 @@ Within the object returned, two main methods are given:
Given a set of options (same ones as the `buildBundle`, a `metro-server` will be returned. You can then hook this into a proper HTTP(S) server by using its `processRequest` method: Given a set of options (same ones as the `buildBundle`, a `metro-server` will be returned. You can then hook this into a proper HTTP(S) server by using its `processRequest` method:
``` ```js
'use strict'; 'use strict';
const http = require('http'); const http = require('http');
@ -49,7 +49,7 @@ httpServer.listen(8081);
In order to be also compatible with express apps, processRequest will also call its third parameter when the request could not be handled by Metro bundler. This will allow you integrating the server in your existing server, or extend a new one: In order to be also compatible with express apps, processRequest will also call its third parameter when the request could not be handled by Metro bundler. This will allow you integrating the server in your existing server, or extend a new one:
``` ```js
const httpServer = http.createServer((req, res) => { const httpServer = http.createServer((req, res) => {
metroBundlerServer.processRequest(req, res, () => { metroBundlerServer.processRequest(req, res, () => {
// Metro does not know how to handle the request. // Metro does not know how to handle the request.
@ -59,7 +59,7 @@ const httpServer = http.createServer((req, res) => {
If you are using [Express](http://expressjs.com/), you can just pass `processRequest` as a middleware: If you are using [Express](http://expressjs.com/), you can just pass `processRequest` as a middleware:
``` ```js
const express = require('express'); const express = require('express');
const app = express(); const app = express();
@ -139,7 +139,7 @@ The JavaScript transformer (`transformModulePath`) is the place where JS code wi
Mandatory method that will transform code. The object received has information about the module being transformed (e.g its path, code...) and the returned object has to contain a `code` key that is the result of the transform. The default transformer shipped is a pretty good place to start: Mandatory method that will transform code. The object received has information about the module being transformed (e.g its path, code...) and the returned object has to contain a `code` key that is the result of the transform. The default transformer shipped is a pretty good place to start:
``` ```js
module.exports.transform = file => { module.exports.transform = file => {
return { return {
code: file.src, code: file.src,
@ -149,7 +149,7 @@ module.exports.transform = file => {
If you would like to plug-in babel, you can simply do that by passing the code to it: If you would like to plug-in babel, you can simply do that by passing the code to it:
``` ```js
const {transform} = require('babel-core'); const {transform} = require('babel-core');
module.exports.transform = file => { module.exports.transform = file => {