Restructure repository

Author: linuswillner

.eslintignore

@@ -1,5 +1,5 @@
 node_modules/*
 coverage/*
-lib/*
+dist/*
 build/*
 .vscode/*

.gitignore

@@ -7,7 +7,7 @@ npm-debug.log*
 node_modules
 
 # Production output
-lib
+dist
 build
 
 # Codecov

.npmignore

@@ -1,4 +1,5 @@
-src
+demo
+lib
 coverage
 test
 .circleci

CHANGELOG.md

@@ -32,7 +32,7 @@ The following style-related props have been removed and replaced:
 + inputStyle
 ```
 
-Instead of having a unique prop for styling only some parts of the terminal elements, every style aspect is now overridable. Any styles defines in [src/defs/styles/Terminal.js](src/defs/styles/Terminal.js) can be overridden via the new props. See [the guide](docs/CONFIG.md#re-styling) for more details.
+Instead of having a unique prop for styling only some parts of the terminal elements, every style aspect is now overridable. Any styles defines in [lib/defs/styles/Terminal.js](lib/defs/styles/Terminal.js) can be overridden via the new props. See [the guide](docs/CONFIG.md#re-styling) for more details.
 
 ### Other changes
 

src/App.jsx demo/App.jsx

@@ -1,7 +1,7 @@
 // react-console-emulator example app
 import React from 'react'
 
-import Terminal from './components/Terminal' // In your app, import from 'react-console-emulator'
+import Terminal from '../lib/Terminal' // In your app, import from 'react-console-emulator'
 import './demo.scss' // Demo only
 
 // Demo only

src/demo.scss demo/demo.scss

@@ -76,15 +76,15 @@ The only notable caveat of this method is the breaking of component encapsulatio
 
 Per standard, the terminal operates in the following way when a command is entered. You can hook into these processes when the terminal is exposed via the refs API.
 
-- A key event triggers the [handleInput](src/components/Terminal.jsx#L242) function.
-- The [handleInput](src/components/Terminal.jsx#L242) function behaves as follows:
-  - If the either up or down arrow was pressed, [scrollHistory](src/components/Terminal.jsx#L200) is called with either `up` or `down` as a parameter, corresponding to the arrow key that was pressed.
-  - If the Enter key was pressed, [processCommand](src/components/Terminal.jsx#L163) is called.
-- Following the Enter path, if automatic output isn't disabled via the `noAutomaticStdout` prop, [pushToStdout](src/components/Terminal.jsx#L128) is called for the first time. This echoes the command that was entered into the terminal verbatim to mimic a UNIX terminal.
+- A key event triggers the [handleInput](../lib/Terminal.jsx#L164) function.
+- The [handleInput](../lib/Terminal.jsx#L164) function behaves as follows:
+  - If the either up or down arrow was pressed, [scrollHistory](../lib/Terminal.jsx#L151) is called with either `up` or `down` as a parameter, corresponding to the arrow key that was pressed.
+  - If the Enter key was pressed, [processCommand](../lib/Terminal.jsx#111) is called.
+- Following the Enter path, if automatic output isn't disabled via the `noAutomaticStdout` prop, [pushToStdout](../lib/Terminal.jsx#L85) is called for the first time. This echoes the command that was entered into the terminal verbatim to mimic a UNIX terminal.
   - If history isn't disabled via the `noHistory` prop, the entered command is also stored in the history at this stage.
 - If the input isn't empty, command processing begins.
   - If the command doesn't exist, an error message is pushed to the output. If a custom error text is set via the `errorText` prop, it takes precedence over the default one.
   - If the command exists, the command function is executed and the return value of that function is pushed to the terminal (Without storing the return value in history). If the `explicitExec` property on the command object is truthy, the function will explicitly execute a second time after the output being sent.
-- The [clearInput](src/components/Terminal.jsx#L158) function is called.
+- The [clearInput](../lib/Terminal.jsx#L106) function is called.
 - If automatic scrolling isn't disabled via the `noAutoScroll` prop, the terminal will scroll to the bottom of the output.
 - If a command callback function is defined via the `commandCallback` prop, it is called at this stage.

src/index.html demo/index.html

@@ -3,6 +3,6 @@ module.exports = {
   preset: 'jest-puppeteer',
   setupFilesAfterEnv: ['<rootDir>/test/setupTests.js'],
   collectCoverage: true,
-  collectCoverageFrom: ['<rootDir>/src/components/Terminal.jsx'],
+  collectCoverageFrom: ['<rootDir>/lib/Terminal.jsx'],
   coverageDirectory: './coverage/'
 }

src/index.jsx demo/index.jsx

@@ -6,12 +6,12 @@ import isEqual from 'react-fast-compare'
 import TerminalMessage from './TerminalMessage'
 
 // Handlers
-import validateCommands from '../handlers/validateCommands'
-import scrollHistory from '../handlers/scrollHistory'
+import validateCommands from './handlers/validateCommands'
+import scrollHistory from './handlers/scrollHistory'
 
 // Definitions
-import sourceStyles from '../defs/styles/Terminal'
-import types from '../defs/types/Terminal'
+import sourceStyles from './defs/styles/Terminal'
+import types from './defs/types/Terminal'
 
 export default class Terminal extends Component {
   constructor (props) {

docs/API.md

@@ -1,8 +1,8 @@
 import React, { Component } from 'react'
 import html from 'react-inner-html'
 
-import types from '../defs/types/TerminalMessage'
-import sourceStyles from '../defs/styles/TerminalMessage'
+import types from './defs/types/TerminalMessage'
+import sourceStyles from './defs/styles/TerminalMessage'
 
 export default class TerminalMessage extends Component {
   static propTypes = types

jest.coverage.js

@@ -2,14 +2,14 @@
   "name": "react-console-emulator",
   "version": "3.0.3",
   "description": "A simple terminal emulator component for React. ",
-  "main": "lib/components/Terminal.js",
+  "main": "dist/Terminal.js",
   "files": [
-    "lib/**"
+    "dist/**"
   ],
   "scripts": {
     "start": "cross-env NODE_ENV=development webpack-dev-server",
     "build": "cross-env NODE_ENV=production webpack -p",
-    "compile": "babel src --ignore \"src/**/*.scss\",\"src/**/*.html\",\"src/App.jsx\",\"src/index.jsx\" --out-dir lib",
+    "compile": "babel lib --out-dir dist",
     "lint": "eslint .",
     "lint-fix": "eslint . --fix",
     "codecov": "codecov --disable=gcov",

src/components/Terminal.jsx lib/Terminal.jsx

@@ -4,16 +4,16 @@ import React from 'react'
 import { shallow, mount, render } from 'enzyme'
 import skipIf from 'skip-if'
 
-import * as src from '../src/components/Terminal'
-import * as prod from '../lib/components/Terminal'
+import * as src from '../lib/Terminal'
+import * as prod from '../dist/Terminal'
 
 let Terminal
 
 if (process.env.PROD_RUN) {
-  console.log('Performing production run, testing version from "lib".')
+  console.log('Performing production run, testing version from "dist".')
   Terminal = prod.default
 } else {
-  console.log('Performing development run, testing version from "src".')
+  console.log('Performing development run, testing version from "lib".')
   Terminal = src.default
 }
 

src/components/TerminalMessage.jsx lib/TerminalMessage.jsx

@@ -8,7 +8,7 @@ const OptimizeJSWebpackPlugin = require('terser-webpack-plugin')
 const dev = process.env.NODE_ENV !== 'production' || process.argv.indexOf('-p') === -1
 
 const HTMLInjecterConfig = new HTMLWebpackPlugin({
-  template: path.join(__dirname, '/src/index.html'),
+  template: path.join(__dirname, '/demo/index.html'),
   filename: 'index.html',
   inject: 'body'
 })
@@ -52,7 +52,7 @@ module.exports = {
   // Entry point
   entry: [
     'react-hot-loader/patch',
-    path.join(__dirname, '/src/index.jsx')
+    path.join(__dirname, '/demo/index.jsx')
   ],
 
   // Dummies for native Node modules not present in browser scope