https://github.com/btholt/sfo

DEPRECATED: Instant build process
https://github.com/btholt/sfo

Last synced: 3 months ago
JSON representation

DEPRECATED: Instant build process

• Host: GitHub
• URL: https://github.com/btholt/sfo
• Owner: btholt
• License: apache-2.0
• Created: 2017-10-01T00:14:01.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2018-04-26T01:25:43.000Z (over 6 years ago)
• Last Synced: 2024-04-24T05:53:06.971Z (7 months ago)
• Language: JavaScript
• Homepage:
• Size: 173 KB
• Stars: 229
• Watchers: 3
• Forks: 24
• Open Issues: 17
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Deprecated

This library was a ton of fun to create and I think had a pretty good developer experience. However I don't have the time or the use case anymore to devote to curating an ongoing great experience around it. In light of that, I'd say [Parcel](http://parceljs.org/) achieves the same goals that sfo aspired to. Highly recommended!

sfo
 




    





  Your build process within a single command



## Table of Contents

* [Introduction](#introduction)

* [How to use](#use)

* [Commands](#commands)

* [Future](#future)

## Introduction

A build process in a command. Just run:

`npx sfo dev `

and SFO takes care of spinning up a build process and dev server for you!

If you don't want to use npx, run:

`npm install --global sfo` then run

`sfo dev `.

But you say you use Angular/Ember/Vue/React etc...No problem. sfo with work with your framework of choice.

## What am I getting?

* Webpack

* Babel

  * preset-env

  * Flow annotation removal

  * JSX

* Importable CSS which is run through PostCSS

  * cssnano

  * postcss-import

  * cssnext

* ESLint with rules for Flow, Airbnb, and Prettier

* vue-loader with buble for Vue users (doesn't affect you if you don't use `.vue` files.)

## Use

In your entry file, just export a default function that accepts a DOM node. It's then up to you to render whatever you want to the DOM!

## React Example

```es6

import React from 'react';

import { render } from 'react-dom';

import './my-styles.css';

const App = () => 
Hello World!
;


export default function (node) {

  render(, node);

}

```

## Commands

* `sfo dev ` - Runs the dev process with nice debugging features.

* `sfo bundle ` - Outputs a production build to the `./build` directory. You can take this and then deploy it easily.

* `sfo size ` - Get a nice visualization of your production bundle to see where you can cut down on file size.

## Flags

* `--no-eslint` - Run sfo without the Airbnb eslint rules

## Shadowing

Sometimes you need a bit more customization than sfo initially allows. sfo has a "shadowing" feature that if it detects that you have your own configuration for one of the tools, it'll use your config instead of its own. Shadowing works for the following:

* `./index.html` - sfo has its own index.html that it uses for your default page but it will use your index.html if it finds it. sfo will smartly inject the built CSS and JS so you don't have to worry about those. Its only requirement is that you have a `#root` element somewhere that it provide that element to the exported function.

* `./.babelrc` - If you have a different config for Babel than what's provided then it will use that. For now, only `./.babelrc` works and other locations of Babel configs (like package.json) don't work.

Due to how ESLint loads plugins, it cannot be shadowed. Use `--no-eslint` for now instead.

## This isn't very configurable.

Feature-not-a-bug.

## Future

Lots to do here. This is just the start and we would love your feedback and help to make it happen. Look at the issues if you want to see my roadmap.