chore: update confit

.circleci/config.yml

@@ -1,65 +1,87 @@
 version: 2
-
-create-cache-file: &create-cache-file
-  run:
-    name: Setup cache
-    command: echo "$NODE_VERSION" > _cache_node_version
-
-package-json-cache: &package-json-cache
-  key: npm-install-{{ checksum "_cache_node_version" }}-{{ checksum "package-lock.json" }}
-
-base-build: &base-build
-  steps:
-    - checkout
-    - <<: *create-cache-file
-    - restore_cache:
-        <<: *package-json-cache
-    - run:
-        name: Install
-        command: npm install
-    - save_cache:
-        <<: *package-json-cache
-        paths:
-          - node_modules
-    - run:
-        name: Lint
-        command: npm run verify:js
-    - run:
-        name: Test
-        command: npm run test:unit:once
-
 jobs:
-  test_node_10:
+  build_node_8:
     docker:
-      - image: circleci/node:10
-    environment:
-      - NODE_VERSION: 10
-    <<: *base-build
+      - image: circleci/node:8
+    steps:
+      - checkout
+      - restore_cache:
+          key: npm-install-node-8-{{ checksum "package.json" }}
+      - run:
+          name: Install
+          command: npm install
+      - save_cache:
+          key: npm-install-node-8-{{ checksum "package.json" }}
+          paths:
+            - node_modules
+
+  build_node_6:
+    docker:
+      - image: circleci/node:6
+    steps:
+      - checkout
+      - restore_cache:
+          key: npm-install-node-6-{{ checksum "package.json" }}
+      - run:
+          name: Install
+          command: npm install
+      - save_cache:
+          key: npm-install-node-6-{{ checksum "package.json" }}
+          paths:
+            - node_modules
+
+  lint:
+    docker:
+      - image: circleci/node:8
+    steps:
+      - checkout
+      - restore_cache:
+          key: npm-install-node-8-{{ checksum "package.json" }}
+      - run:
+          name: Lint
+          command: npm run verify:js
 
   test_node_8:
     docker:
       - image: circleci/node:8
-    environment:
-      - NODE_VERSION: 8
-    <<: *base-build
+    steps:
+      - checkout
+      - restore_cache:
+          key: npm-install-node-8-{{ checksum "package.json" }}
+      - run:
+          name: Test Node 8
+          command: npm run test:coverage
+          when: always
+      - store_test_results:
+          path: reports
+      - store_artifacts:
+          path: reports/coverage
+          prefix: coverage
 
   test_node_6:
     docker:
       - image: circleci/node:6
-    environment:
-      - NODE_VERSION: 6
-    <<: *base-build
+    steps:
+      - checkout
+      - restore_cache:
+          key: npm-install-node-6-{{ checksum "package.json" }}
+      - run:
+          name: Test Node 6
+          command: npm run test:coverage
+          when: always
+      - store_test_results:
+          path: reports
+      - store_artifacts:
+          path: reports/coverage
+          prefix: coverage
 
   release:
     docker:
       - image: circleci/node:8
-    environment:
-      - NODE_VERSION: 8
     steps:
       - checkout
-      - <<: *create-cache-file
       - restore_cache:
-          <<: *package-json-cache
+          key: npm-install-node-6-{{ checksum "package.json" }}
       - run:
           name: Update NPM
           command: |
@@ -74,35 +96,45 @@ workflows:
   version: 2
   test_and_tag:
     jobs:
-      - test_node_10:
+      - build_node_8:
           filters:
             branches:
               only: master
-      - test_node_8:
+      - build_node_6:
           filters:
             branches:
               only: master
+      - lint:
+          requires:
+            - build_node_8
       - test_node_6:
-          filters:
-            branches:
-              only: master
+          requires:
+            - build_node_6
+      - test_node_8:
+          requires:
+            - build_node_8
       - release:
           requires:
+            - lint
             - test_node_6
             - test_node_8
-            - test_node_10
 
   build_and_test:
     jobs:
-      - test_node_10:
+      - build_node_8:
           filters:
             branches:
               ignore: master
-      - test_node_8:
+      - build_node_6:
           filters:
             branches:
               ignore: master
+      - lint:
+          requires:
+            - build_node_8
       - test_node_6:
-          filters:
-            branches:
-              ignore: master
+          requires:
+            - build_node_6
+      - test_node_8:
+          requires:
+            - build_node_8

.nycrc

@@ -0,0 +1,24 @@
+{
+    "check-coverage": true,
+    "per-file": false,
+    "lines": 90,
+    "statements": 90,
+    "functions": 85,
+    "branches": 75,
+    "include": [
+      "src/**/*.js"
+    ],
+    "exclude": [
+      "test/**/*.spec.js"
+    ],
+    "reporter": [
+      "lcovonly",
+      "html",
+      "text",
+      "cobertura",
+      "json"
+    ],
+    "cache": true,
+    "all": true,
+    "report-dir": "./reports/coverage/"
+}

CONTRIBUTING.md

@@ -1,20 +1,211 @@
-<p align="center">
-  <a href="https://github.com/trs/ftp-srv">
-    <img alt="ftp-srv" src="logo.png" width="400px"  />
-  </a>
-</p>
+<!--[CN_HEADING]-->
+# Contributing
 
-<h1 align="center">
-  Contributing Guide
-</h1>
+Welcome! This document explains how you can contribute to making **ftp-srv** even better.
 
-## Welcome
 
-- Thank you for your eagerness to contribute, pull requests are encouraged!
+<!--[]-->
+
+<!--[CN_GETTING_STARTED]-->
+# Getting Started
+
+## Installation
+
+```
+git clone <this repo>
+npm install -g commitizen
+npm install -g semantic-release-cli
+npm install
+```
+
+
+<!--[]-->
+
+<!--[RM_DIR_STRUCTURE]-->
+## Directory Structure
+
+Code is organised into modules which contain one-or-more components. This a great way to ensure maintainable code by encapsulation of behavior logic. A component is basically a self contained app usually in a single file or a folder with each concern as a file: style, template, specs, e2e, and component class. Here's how it looks:
+```
+ftp-srv/
+ ├──config/                       * configuration files live here (e.g. eslint, verify, testUnit)
+ │
+ ├──src/                          * source code files should be here
+ │
+ ├──dist/                         * production-build code should live here
+ │
+ ├──reports/                      * test reports appear here
+ │
+ ├──test/                         * unit test specifications live here
+ │
+ ├──confit.yml                    * the project config file generated by 'yo confit'
+ ├──CONTRIBUTING.md               * how to contribute to the project
+ ├──README.md                     * this file
+ └──package.json                  * NPM package description file
+```
+
+
+<!--[]-->
+
+<!--[CN_GITFLOW_PROCESS]-->
+# GitFlow Development Process
+
+This project uses the [GitHub Flow](https://guides.github.com/introduction/flow/index.html) workflow.
+
+## Create a branch
+When you're working on a project, you're going to have a bunch of different features or ideas in progress at any given time – some of which are ready to go, and others which are not. Branching exists to help you manage this workflow.
+
+When you create a branch in your project, you're creating an environment where you can try out new ideas. Changes you make on a branch don't affect the `master` branch, so you're free to experiment and commit changes, safe in the knowledge that your branch won't be merged until it's ready to be reviewed by someone you're collaborating with.
+
+###ProTip
+
+Branching is a core concept in Git, and the entire GitHub Flow is based upon it. There's only one rule: anything in the `master` branch is always deployable.
+
+Because of this, it's extremely important that your new branch is created off of `master` when working on a feature or a fix. Your branch name should be descriptive (e.g., `refactor-authentication`, `user-content-cache-key`, `make-retina-avatars`), so that others can see what is being worked on.
+
+## Add commits
+Once your branch has been created, it's time to start making changes. Whenever you add, edit, or delete a file, you're making a commit, and adding them to your branch. This process of adding commits keeps track of your progress as you work on a feature branch.
+
+Commits also create a transparent history of your work that others can follow to understand what you've done and why. Each commit has an associated commit message, which is a description explaining why a particular change was made. Furthermore, each commit is considered a separate unit of change. This lets you roll back changes if a bug is found, or if you decide to head in a different direction.
+
+###ProTip
+
+Commit messages are important, especially since Git tracks your changes and then displays them as commits once they're pushed to the server. By writing clear commit messages, you can make it easier for other people to follow along and provide feedback.
+
+## Open a pull request
+
+Pull Requests initiate discussion about your commits. Because they're tightly integrated with the underlying Git repository, anyone can see exactly what changes would be merged if they accept your request.
+
+You can open a Pull Request at any point during the development process: when you have little or no code but want to share some screenshots or general ideas, when you're stuck and need help or advice, or when you're ready for someone to review your work. By using GitHub's @mention system in your Pull Request message, you can ask for feedback from specific people or teams, whether they're down the hall or ten time zones away.
+
+###ProTip
+
+Pull Requests are useful for contributing to open source projects and for managing changes to shared repositories. If you're using a Fork & Pull Model, Pull Requests provide a way to notify project maintainers about the changes you'd like them to consider. If you're using a Shared Repository Model, Pull Requests help start code review and conversation about proposed changes before they're merged into the `master` branch.
+
+## Discuss and review your code
+Once a Pull Request has been opened, the person or team reviewing your changes may have questions or comments. Perhaps the coding style doesn't match project guidelines, the change is missing unit tests, or maybe everything looks great and props are in order. Pull Requests are designed to encourage and capture this type of conversation.
+
+You can also continue to push to your branch in light of discussion and feedback about your commits. If someone comments that you forgot to do something or if there is a bug in the code, you can fix it in your branch and push up the change. GitHub will show your new commits and any additional feedback you may receive in the unified Pull Request view.
+
+###ProTip
+
+Pull Request comments are written in Markdown, so you can embed images and emoji, use pre-formatted text blocks, and other lightweight formatting.
+
+## Merge to `master`
+
+Once your PR has passed any the integration tests and received approval to merge, it is time to merge your code into the `master` branch.
+
+Once merged, Pull Requests preserve a record of the historical changes to your code. Because they're searchable, they let anyone go back in time to understand why and how a decision was made.
+
+###ProTip
+
+By incorporating certain keywords into the text of your Pull Request, you can associate issues with code. When your Pull Request is merged, the related issues are also closed. For example, entering the phrase Closes #32 would close issue number 32 in the repository. For more information, check out our help article.
+
+
+<!--[]-->
+
+<!--[CN_BUILD_TASKS]-->
+## Build Tasks
+
+Command | Description
+:------ | :----------
+<pre>npm run build</pre> | Generate production build into [dist/](dist/) folder
+<pre>npm run dev</pre> | Run project in development mode (verify code, and re-verify when code is changed)
+<pre>npm start</pre> | Alias for `npm run dev` task
+
+
+
+<!--[]-->
+
+<!--[CN_TEST_TASKS]-->
+## Test Tasks
+
+Command | Description
+:------ | :----------
+<pre>npm test</pre> | Alias for `npm run test:unit` task
+<pre>npm run test:coverage</pre> | Run instrumented unit tests then verify coverage meets defined thresholds<ul><li>Returns non-zero exit code when coverage does not meet thresholds (as defined in istanbul.js)</li></ul>
+<pre>npm run test:unit</pre> | Run unit tests whenever JS source or tests change<ul><li>Uses Mocha</li><li>Code coverage</li><li>Runs continuously (best to run in a separate window)</li></ul>
+<pre>npm run test:unit:once</pre> | Run unit tests once<ul><li>Uses Mocha</li><li>Code coverage</li></ul>
+
+
+
+<!--[]-->
+
+<!--[CN_VERIFY_TASKS]-->
+## Verification (Linting) Tasks
+
+Command | Description
+:------ | :----------
+<pre>npm run verify</pre> | Verify code style and syntax<ul><li>Verifies source *and test code* aginst customisable rules (unlike Webpack loaders)</li></ul>
+<pre>npm run verify:js</pre> | Verify Javascript code style and syntax
+<pre>npm run verify:js:fix</pre> | Verify Javascript code style and syntax and fix any errors that can be fixed automatically
+<pre>npm run verify:js:watch</pre> | Verify Javascript code style and syntax and watch files for changes
+<pre>npm run verify:watch</pre> | Runs verify task whenever JS or CSS code is changed
+
+
+
+<!--[]-->
+
+<!--[CN_COMMIT_TASKS]-->
+## Commit Tasks
+
+Command | Description
+:------ | :----------
+<pre>git status</pre> | Lists the current branch and the status of changed files
+<pre>git log</pre> | Displays the commit log (press Q to quit viewing)
+<pre>git add .</pre> | Stages all modified & untracked files, ready to be committed
+<pre>git cz</pre> | Commit changes to local repository using Commitizen.<ul><li>Asks questions about the change to generate a valid conventional commit message</li><li>Can be customised by modifying [config/release/commitMessageConfig.js](config/release/commitMessageConfig.js)</li></ul>
+<pre>git push</pre> | Push local repository changes to remote repository
+
+
+<!--[]-->
+
+<!--[CN_DOCUMENTATION_TASKS]-->
+
+
+
+<!--[]-->
+
+<!--[CN_RELEASE_TASKS]-->
+## Release Tasks
+
+Command | Description
+:------ | :----------
+<pre>npm run commitmsg</pre> | Git commit message hook that validates the commit message conforms to your commit message conventions.
+<pre>npm run pre-release</pre> | Verify code, run unit tests, check test coverage, build software. This task is designed to be run before
+the `semantic-release` task.
+<ul><li>Run `semantic-release-cli setup` once you have a remote repository. See https://github.com/semantic-release/cli for details.</li><li>Semantic-release integrates with Travis CI (or similar tools) to generate release notes
+for each release (which appears in the "Releases" section in GitHub) and
+publishes the package to NPM (when all the tests are successful) with a semantic version number.
+</li></ul>
+<pre>npm run prepush</pre> | Git pre-push hook that verifies code and checks unit test coverage meet minimum thresholds.
+<pre>npm run upload-coverage</pre> | Uploads code-coverage metrics to Coveralls.io<ul><li>Setup - https://coveralls.zendesk.com/hc/en-us/articles/201347419-Coveralls-currently-supports</li><li>Define an environment variable called COVERALLS_REPO_TOKEN in your build environment with the repo token from https://coveralls.io/github/<repo-name>/settings</li><li>In your CI configuration (e.g. `travis.yml`), call `npm run upload-coverage` if the build is successful.</li></ul>
+
+
+
+<!--[]-->
+
+
+<!--[CN_CHANGING_BUILD_TOOL_CONFIG]-->
+## Changing build-tool configuration
+
+There are 3 ways you can change the build-tool configuration for this project:
+
+1. BEST: Modify the Confit configuration file ([confit.yml](confit.yml)) by hand, then re-run `yo confit` and tell it to use the existing configuration.
+1. OK: Re-run `yo confit` and provide new answers to the questions. **Confit will attempt to overwrite your existing configuration (it will prompt for confirmation), so make sure you have committed your code to a source control (e.g. git) first**.
+  There are certain configuration settings which can **only** be specified by hand, in which case the first approach is still best.
+1. RISKY: Modify the generated build-tool config by hand. Be aware that if you re-run `yo confit` it will attempt to overwrite your changes. So commit your changes to source control first.
+
+Additionally, the **currently-generated** configuration can be extended in the following ways:
+
+- The task configuration is defined in [package.json](package.json). It is possible to change the task definitions to add your own sub-tasks.
+You can also use the `pre...` and `post...` script-name prefixes to run commands before (pre) and after (post) the generated commands.
+
+- The `entryPoint.entryPoints` string in [confit.yml](confit.yml) is designed to be edited manually. It represents the starting-point(s) of the application (like a `main()` function). A NodeJS application has one entry point. E.g. `src/index.js`
+
+
+
+
+<!--[]-->
+
 
-## Guidelines
 
-- Any new fixes are features should include new or updated [tests](/test).
-- Commits follow the [AngularJS Git Commit Message Conventions](https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit), please review and commit accordingly
-- Submit your pull requests to the `master` branch, these will normally be merged into a seperate branch for any finally changes before being merged into `master`.
-- Submit any bugs or requests to the issues page in Github.

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018 Tyler Stewart
+Copyright (c) 2017 Tyler Stewart
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -15,259 +15,71 @@
   </a>
 
   <a href="https://circleci.com/gh/trs/ftp-srv">
-    <img alt="circleci" src="https://img.shields.io/circleci/project/github/trs/ftp-srv.svg?style=for-the-badge" />
+    <img alt="npm" src="https://img.shields.io/circleci/project/github/trs/ftp-srv.svg?style=for-the-badge" />
+  </a>
+
+  <a href="https://coveralls.io/github/trs/ftp-srv?branch=master">
+    <img alt="npm" src="https://img.shields.io/coveralls/github/trs/ftp-srv.svg?style=for-the-badge" />
   </a>
 </p>
 
 ---
 
-- [Overview](#overview)
-- [Features](#features)
-- [Install](#install)
-- [Usage](#usage)
-  - [API](#api)
-  - [Events](#events)
-  - [Supported Commands](#supported-commands)
-  - [File System](#file-system)
-- [Contributing](#contributing)
-- [License](#license)
+## Synopsis
 
-## Overview
-`ftp-srv` is a modern and extensible FTP server designed to be simple yet configurable.
+`ftp-srv` is an extensible FTP server solution that enables custom file systems per connection allowing the use of virtual file systems. By default, it acts like a regular FTP server. Just include it in your project and start listening.
 
 ## Features
-- Extensible [file systems](#file-system) per connection
-- Passive and active transfers
+
+- Passive and Active transfer support
 - [Explicit](https://en.wikipedia.org/wiki/FTPS#Explicit) & [Implicit](https://en.wikipedia.org/wiki/FTPS#Implicit) TLS connections
+- Extensible [file systems](#file-system) per connection
 - Promise based API
 
 ## Install
-`npm install ftp-srv --save`
 
-## Usage
+```
+$ npm install ftp-srv
+``` 
+
+## Quick Start
 
 ```js
-// Quick start
-
 const FtpSrv = require('ftp-srv');
-const ftpServer = new FtpSrv('ftp://0.0.0.0:9876', { options ... });
 
-ftpServer.on('login', (data, resolve, reject) => { ... });
-...
+const ftpServer = new FtpSrv('ftp://0.0.0.0:9876');
+
+ftpServer.on('login', ({connection, username, password}, resolve, reject) => {
+  // fetch credentials from database, file, or hard coded
+  database.users.fetch({username, password})
+  .then(() => {
+    connection.on('STOR', (err, file) => console.log(`Uploaded file: ${file}`));
+
+    resolve({
+      root: '/'
+    });
+  })
+  .catch(() => reject);
+});
 
 ftpServer.listen()
-.then(() => { ... });
+.then(() => {
+  console.log('Waiting for connections!');
+});
 ```
 
 ## API
 
-### `new FtpSrv(url, [{options}])`
-#### url
-[URL string](https://nodejs.org/api/url.html#url_url_strings_and_url_objects) indicating the protocol, hostname, and port to listen on for connections.
-Supported protocols:
-- `ftp` Plain FTP
-- `ftps` Implicit FTP over TLS
+Checkout the [Documentation](/docs).
 
-_Note:_ The hostname must be the external IP address to accept external connections. Setting the hostname to `0.0.0.0` will automatically set the external IP.
-__Default:__ `"ftp://127.0.0.1:21"`
-
-#### options
-
-##### `pasv_range`
-A starting port (eg `8000`) or a range (eg `"8000-9000"`) to accept passive connections.
-This range is then queried for an available port to use when required.
-__Default:__ `22`
-
-##### `greeting`
-A human readable array of lines or string to send when a client connects.
-__Default:__ `null`
-
-##### `tls`
-Node [TLS secure context object](https://nodejs.org/api/tls.html#tls_tls_createsecurecontext_options) used for implicit (`ftps` protocol) or explicit (`AUTH TLS`) connections.
-__Default:__ `false`
-
-##### `anonymous`
-If true, will allow clients to authenticate using the username `anonymous`, not requiring a password from the user.
-Can also set as a string which allows users to authenticate using the username provided.
-The `login` event is then sent with the provided username and `@anonymous` as the password.
-__Default:__ `false`
-
-##### `blacklist`
-Array of commands that are not allowed.
-Response code `502` is sent to clients sending one of these commands.
-__Example:__ `['RMD', 'RNFR', 'RNTO']` will not allow users to delete directories or rename any files.
-__Default:__ `[]`
-
-##### `whitelist`
-Array of commands that are only allowed.
-Response code `502` is sent to clients sending any other command.
-__Default:__ `[]`
-
-##### `file_format`
-Sets the format to use for file stat queries such as `LIST`.
-__Default:__ `"ls"`
-__Allowable values:__
-  - `ls` [bin/ls format](https://cr.yp.to/ftp/list/binls.html)
-  - `ep` [Easily Parsed LIST format](https://cr.yp.to/ftp/list/eplf.html)
-  - `function () {}` A custom function returning a format or promise for one.
-    - Only one argument is passed in: a node [file stat](https://nodejs.org/api/fs.html#fs_class_fs_stats) object with additional file `name` parameter
-
-##### `log`
-A [bunyan logger](https://github.com/trentm/node-bunyan) instance. Created by default.
-
-## Events
-
-The `FtpSrv` class extends the [node net.Server](https://nodejs.org/api/net.html#net_class_net_server). Some custom events can be resolved or rejected, such as `login`.
-
-### `login`
-```js
-on('login', ({connection, username, password}, resolve, reject) => { ... });
-```
-
-Occurs when a client is attempting to login. Here you can resolve the login request by username and password.
-
-`connection` [client class object](src/connection.js)
-`username` string of username from `USER` command
-`password` string of password from `PASS` command
-`resolve` takes an object of arguments:
-- `fs`
-  - Set a custom file system class for this connection to use.
-  - See [File System](#file-system) for implementation details.
-- `root`
-  - If `fs` is not provided, this will set the root directory for the connection.
-  - The user cannot traverse lower than this directory.
-- `cwd`
-  - If `fs` is not provided, will set the starting directory for the connection
-  - This is relative to the `root` directory.
-- `blacklist`
-  - Commands that are forbidden for only this connection
-- `whitelist`
-  - If set, this connection will only be able to use the provided commands
-
-`reject` takes an error object
-
-### `client-error`
-```js
-on('client-error', ({connection, context, error}) => { ... });
-```
-
-Occurs when an error arises in the client connection.
-
-`connection` [client class object](src/connection.js)
-`context` string of where the error occured
-`error` error object
-
-### `RETR`
-```js
-on('RETR', (error, filePath) => { ... });
-```
-
-Occurs when a file is downloaded.
-
-`error` if successful, will be `null`
-`filePath` location to which file was downloaded
-
-### `STOR`
-```js
-on('STOR', (error, fileName) => { ... });
-```
-
-Occurs when a file is uploaded.
-
-`error` if successful, will be `null`
-`fileName` name of the file that was downloaded
-
-## Supported Commands
-
-See the [command registry](src/commands/registration) for a list of all implemented FTP commands.
-
-## File System
-The default [file system](src/fs.js) can be overwritten to use your own implementation.
-This can allow for virtual file systems, and more.
-Each connection can set it's own file system based on the user.
-
-The default file system is exported and can be extended as needed:
-```js
-const {FtpSrv, FileSystem} = require('ftp-srv');
-
-class MyFileSystem extends FileSystem {
-  constructor() {
-    super(...arguments);
-  }
-
-  get(fileName) {
-    ...
-  }
-}
-```
-
-Custom file systems can implement the following variables depending on the developers needs:
-
-### Methods
-#### [`currentDirectory()`](src/fs.js#L29)
-Returns a string of the current working directory
-__Used in:__ `PWD`
-
-#### [`get(fileName)`](src/fs.js#L33)
-Returns a file stat object of file or directory
-__Used in:__ `LIST`, `NLST`, `STAT`, `SIZE`, `RNFR`, `MDTM`
-
-#### [`list(path)`](src/fs.js#L39)
-Returns array of file and directory stat objects
-__Used in:__ `LIST`, `NLST`, `STAT`
-
-#### [`chdir(path)`](src/fs.js#L56)
-Returns new directory relative to current directory
-__Used in:__ `CWD`, `CDUP`
-
-#### [`mkdir(path)`](src/fs.js#L96)
-Returns a path to a newly created directory
-__Used in:__ `MKD`
-
-#### [`write(fileName, {append, start})`](src/fs.js#L68)
-Returns a writable stream
-Options:
- `append` if true, append to existing file
- `start` if set, specifies the byte offset to write to
-__Used in:__ `STOR`, `APPE`
-
-#### [`read(fileName, {start})`](src/fs.js#L75)
-Returns a readable stream
-Options:
- `start` if set, specifies the byte offset to read from
-__Used in:__ `RETR`
-
-#### [`delete(path)`](src/fs.js#L87)
-Delete a file or directory
-__Used in:__ `DELE`
-
-#### [`rename(from, to)`](src/fs.js#L102)
-Renames a file or directory
-__Used in:__ `RNFR`, `RNTO`
-
-#### [`chmod(path)`](src/fs.js#L108)
-Modifies a file or directory's permissions
-__Used in:__ `SITE CHMOD`
-
-#### [`getUniqueName()`](src/fs.js#L113)
-Returns a unique file name to write to
-__Used in:__ `STOU`
-
-<!--[RM_CONTRIBUTING]-->
 ## Contributing
 
 See [CONTRIBUTING.md](CONTRIBUTING.md).
 
-
-<!--[]-->
-
-<!--[RM_LICENSE]-->
 ## License
 
 This software is licensed under the MIT Licence. See [LICENSE](LICENSE).
 
-<!--[]-->
-
 ## References
 
 - [https://cr.yp.to/ftp.html](https://cr.yp.to/ftp.html)

config/testUnit/reporters.json

@@ -1,5 +1,5 @@
 {
-  "reporterEnabled": "spec",
+  "reporterEnabled": "mocha-pretty-bunyan-nyan",
   "mochaJunitReporterReporterOptions": {
     "mochaFile": "reports/junit.xml"
   }

confit.yml

@@ -0,0 +1,49 @@
+generator-confit:
+  app:
+    _version: 462ecd915fd9db1aef6a37c2b5ce8b58b80c18ba
+    buildProfile: Latest
+    copyrightOwner: Tyler Stewart
+    license: MIT
+    projectType: node
+    publicRepository: true
+    repositoryType: GitHub
+  paths:
+    _version: 780b129e0c7e5cab7e29c4f185bcf78524593a33
+    config:
+      configDir: config/
+    input:
+      srcDir: src/
+      unitTestDir: test/
+    output:
+      prodDir: dist/
+      reportDir: reports/
+  buildJS:
+    _version: ead8ce4280b07d696aff499a5fca1a933727582f
+    framework: []
+    frameworkScripts: []
+    outputFormat: ES6
+    sourceFormat: ES6
+  entryPoint:
+    _version: 39082c3df887fbc08744dfd088c25465e7a2e3a4
+    entryPoints:
+      main:
+        - ftp-srv.js
+  testUnit:
+    _version: 30eee42a88ee42cce4f1ae48fe0cbe81647d189a
+    testDependencies: []
+    testFramework: mocha
+  verify:
+    _version: 30ae86c5022840a01fc08833e238a82c683fa1c7
+    jsCodingStandard: none
+  documentation:
+    _version: b1658da3278b16d1982212f5e8bc05348af20e0b
+    generateDocs: false
+  release:
+    _version: 47f220593935b502abf17cb34a396f692e453c49
+    checkCodeCoverage: true
+    commitMessageFormat: Conventional
+    useSemantic: true
+  sampleApp:
+    _version: 00c0a2c6fc0ed17fcccce2d548d35896121e58ba
+    createSampleApp: false
+  zzfinish: {}

docs/README.md

@@ -0,0 +1,2 @@
+## Documentation
+

ftp-srv.d.ts

@@ -1,6 +1,5 @@
 import * as tls from 'tls'
 import { Stats } from 'fs'
-import { EventEmitter } from 'events';
 
 export class FileSystem {
 
@@ -108,7 +107,7 @@ export class FtpServer {
             whitelist?: Array<string>
         }) => void,
 		reject: (err?: Error) => void
-	) => void): EventEmitter;
+	) => void)
 
 	on(event: "client-error", listener: (
 		data: {
@@ -116,7 +115,7 @@ export class FtpServer {
 			context: string,
 			error: Error,
 		}
-	) => void): EventEmitter;
+	) => void)
 }
 
 export {FtpServer as FtpSrv};

package.json

@@ -23,24 +23,26 @@
     "url": "https://github.com/trs/ftp-srv"
   },
   "scripts": {
-    "pre-release": "npm run verify",
+    "pre-release": "npm-run-all verify test:coverage build ",
+    "build": "cross-env NODE_ENV=production npm run clean:prod",
+    "clean:prod": "rimraf dist/",
     "commitmsg": "cz-customizable-ghooks",
     "dev": "cross-env NODE_ENV=development npm run verify:watch",
-    "prepush": "npm-run-all verify test:unit:once --silent",
+    "prepush": "npm-run-all verify test:coverage --silent",
     "semantic-release": "semantic-release",
     "start": "npm run dev",
     "test": "npm run test:unit",
-    "test:unit": "cross-env NODE_ENV=test mocha --opts config/testUnit/mocha.opts -w",
-    "test:unit:once": "cross-env NODE_ENV=test mocha --opts config/testUnit/mocha.opts",
+    "test:check-coverage": "nyc check-coverage",
+    "test:coverage": "npm-run-all test:unit:once test:check-coverage --silent",
+    "test:unit": "cross-env NODE_ENV=test nyc mocha --opts config/testUnit/mocha.opts -w",
+    "test:unit:once": "cross-env NODE_ENV=test nyc mocha --opts config/testUnit/mocha.opts",
+    "upload-coverage": "cat reports/coverage/lcov.info | coveralls",
     "verify": "npm run verify:js --silent",
     "verify:js": "eslint -c config/verify/.eslintrc \"src/**/*.js\" \"test/**/*.js\" \"config/**/*.js\" && echo ✅ verify:js success",
     "verify:js:fix": "eslint --fix -c config/verify/.eslintrc \"src/**/*.js\" \"test/**/*.js\" \"config/**/*.js\" && echo ✅ verify:js:fix success",
     "verify:js:watch": "chokidar 'src/**/*.js' 'test/**/*.js' 'config/**/*.js' -c 'npm run verify:js:fix' --initial --silent",
     "verify:watch": "npm run verify:js:watch --silent"
   },
-  "release": {
-    "verifyConditions": "condition-circle"
-  },
   "config": {
     "commitizen": {
       "path": "node_modules/cz-customizable"
@@ -52,16 +54,16 @@
   "dependencies": {
     "bluebird": "^3.5.1",
     "bunyan": "^1.8.12",
-    "ip": "^1.1.5",
-    "lodash": "^4.17.10",
-    "moment": "^2.22.1",
-    "uuid": "^3.2.1"
+    "lodash": "^4.17.4",
+    "moment": "^2.19.1",
+    "uuid": "^3.1.0"
   },
   "devDependencies": {
-    "@icetee/ftp": "^1.0.2",
+    "@icetee/ftp": "^0.3.15",
     "chai": "^4.0.2",
     "chokidar-cli": "1.2.0",
     "condition-circle": "^1.6.0",
+    "coveralls": "2.13.1",
     "cross-env": "3.1.4",
     "cz-customizable": "5.2.0",
     "cz-customizable-ghooks": "1.5.0",
@@ -76,13 +78,18 @@
     "mocha": "3.5.0",
     "mocha-junit-reporter": "1.13.0",
     "mocha-multi-reporters": "1.1.5",
-    "npm-run-all": "^4.1.3",
+    "mocha-pretty-bunyan-nyan": "^1.0.4",
+    "npm-run-all": "4.0.2",
+    "nyc": "11.1.0",
     "rimraf": "2.6.1",
     "semantic-release": "^11.0.2",
     "sinon": "^2.3.5"
   },
   "engines": {
     "node": ">=6.x",
-    "npm": ">=5.x"
+    "npm": ">=3.9.5"
+  },
+  "release": {
+    "verifyConditions": "condition-circle"
   }
 }

src/commands/registration/rest.js

@@ -9,7 +9,7 @@ module.exports = {
     if (isNaN(byteCount) || byteCount < 0) return this.reply(501, 'Byte count must be 0 or greater');
 
     this.restByteCount = byteCount;
-    return this.reply(350, `Restarting next transfer at ${byteCount}`);
+    return this.reply(350, `Resarting next transfer at ${byteCount}`);
   },
   syntax: '{{cmd}} <byte-count>',
   description: 'Restart transfer from the specified point. Resets after any STORE or RETRIEVE'

src/commands/registration/retr.js

@@ -6,11 +6,9 @@ module.exports = {
     if (!this.fs) return this.reply(550, 'File system not instantiated');
     if (!this.fs.read) return this.reply(402, 'Not supported by file system');
 
-    const filePath = command.arg;
-
     return this.connector.waitForConnection()
     .tap(() => this.commandSocket.pause())
-    .then(() => Promise.resolve(this.fs.read(filePath, {start: this.restByteCount})))
+    .then(() => Promise.resolve(this.fs.read(command.arg, {start: this.restByteCount})))
     .then(stream => {
       const destroyConnection = (connection, reject) => err => {
         if (connection) connection.destroy(err);
@@ -34,7 +32,6 @@ module.exports = {
 
       return this.reply(150).then(() => stream.resume() && this.connector.socket.resume())
       .then(() => eventsPromise)
-      .tap(() => this.emit('RETR', null, filePath))
       .finally(() => stream.destroy && stream.destroy());
     })
     .then(() => this.reply(226))
@@ -44,7 +41,6 @@ module.exports = {
     })
     .catch(err => {
       log.error(err);
-      this.emit('RETR', err);
       return this.reply(551, err.message);
     })
     .finally(() => {

src/commands/registration/stor.js

@@ -42,7 +42,6 @@ module.exports = {
 
       return this.reply(150).then(() => this.connector.socket.resume())
       .then(() => Promise.join(streamPromise, socketPromise))
-      .tap(() => this.emit('STOR', null, fileName))
       .finally(() => stream.destroy && stream.destroy());
     })
     .then(() => this.reply(226, fileName))
@@ -52,7 +51,6 @@ module.exports = {
     })
     .catch(err => {
       log.error(err);
-      this.emit('STOR', err);
       return this.reply(550, err.message);
     })
     .finally(() => {

src/connection.js

@@ -1,7 +1,6 @@
 const _ = require('lodash');
 const uuid = require('uuid');
 const Promise = require('bluebird');
-const EventEmitter = require('events');
 
 const BaseConnector = require('./connector/base');
 const FileSystem = require('./fs');
@@ -9,9 +8,8 @@ const Commands = require('./commands');
 const errors = require('./errors');
 const DEFAULT_MESSAGE = require('./messages');
 
-class FtpConnection extends EventEmitter {
+class FtpConnection {
   constructor(server, options) {
-    super();
     this.server = server;
     this.id = uuid.v4();
     this.log = options.log.child({id: this.id, ip: this.ip});
@@ -34,7 +32,6 @@ class FtpConnection extends EventEmitter {
     this.commandSocket.on('close', () => {
       if (this.connector) this.connector.end();
       if (this.commandSocket && !this.commandSocket.destroyed) this.commandSocket.destroy();
-      this.removeAllListeners();
     });
   }
 
@@ -46,7 +43,7 @@ class FtpConnection extends EventEmitter {
 
   get ip() {
     try {
-      return this.commandSocket ? this.commandSocket.remoteAddress : undefined;
+      return this.dataSocket ? this.dataSocket.remoteAddress : this.commandSocket.remoteAddress;
     } catch (ex) {
       return null;
     }

src/connector/passive.js

@@ -1,6 +1,5 @@
 const net = require('net');
 const tls = require('tls');
-const ip = require('ip');
 const Promise = require('bluebird');
 
 const Connector = require('./base');
@@ -36,7 +35,7 @@ class Passive extends Connector {
     .then(() => this.getPort())
     .then(port => {
       const connectionHandler = socket => {
-        if (!ip.isEqual(this.connection.commandSocket.remoteAddress, socket.remoteAddress)) {
+        if (this.connection.commandSocket.remoteAddress !== socket.remoteAddress) {
           this.log.error({
             pasv_connection: socket.remoteAddress,
             cmd_connection: this.connection.commandSocket.remoteAddress

src/helpers/file-stat.js

@@ -18,8 +18,7 @@ module.exports = function (fileStat, format = 'ls') {
 function ls(fileStat) {
   const now = moment.utc();
   const mtime = moment.utc(new Date(fileStat.mtime));
-  const timeDiff = now.diff(mtime, 'months');
-  const dateFormat = timeDiff < 6 ? 'MMM DD HH:mm' : 'MMM DD  YYYY';
+  const dateFormat = now.diff(mtime, 'months') < 6 ? 'MMM DD HH:mm' : 'MMM DD  YYYY';
 
   return [
     fileStat.mode ? [

src/index.js

@@ -5,14 +5,12 @@ const buyan = require('bunyan');
 const net = require('net');
 const tls = require('tls');
 const fs = require('fs');
-const EventEmitter = require('events');
 
 const Connection = require('./connection');
 const resolveHost = require('./helpers/resolve-host');
 
-class FtpServer extends EventEmitter {
+class FtpServer {
   constructor(url, options = {}) {
-    super();
     this.options = _.merge({
       log: buyan.createLogger({name: 'ftp-srv'}),
       anonymous: false,
@@ -49,6 +47,9 @@ class FtpServer extends EventEmitter {
 
     this.server = (this.isTLS ? tls : net).createServer(serverOptions, serverConnectionHandler);
     this.server.on('error', err => this.log.error(err, '[Event] error'));
+    this.on = this.server.on.bind(this.server);
+    this.once = this.server.once.bind(this.server);
+    this.listeners = this.server.listeners.bind(this.server);
 
     process.on('SIGTERM', () => this.quit());
     process.on('SIGINT', () => this.quit());
@@ -64,9 +65,7 @@ class FtpServer extends EventEmitter {
     .then(hostname => {
       this.url.hostname = hostname;
       return new Promise((resolve, reject) => {
-        this.server.once('error', reject);
-        this.server.listen(this.url.port, this.url.hostname, err => {
-          this.server.removeListener('error', reject);
+        this.server.listen(this.url.port, err => {
           if (err) return reject(err);
           this.log.info({
             protocol: this.url.protocol.replace(/\W/g, ''),
@@ -82,10 +81,14 @@ class FtpServer extends EventEmitter {
   emitPromise(action, ...data) {
     return new Promise((resolve, reject) => {
       const params = _.concat(data, [resolve, reject]);
-      this.emit.call(this, action, ...params);
+      this.server.emit(action, ...params);
     });
   }
 
+  emit(action, ...data) {
+    this.server.emit(action, ...data);
+  }
+
   setupTLS(_tls) {
     if (!_tls) return false;
     return _.assign({}, _tls, {
@@ -141,8 +144,7 @@ class FtpServer extends EventEmitter {
         if (err) this.log.error(err, 'Error closing server');
         resolve('Closed');
       });
-    }))
-    .then(() => this.removeAllListeners());
+    }));
   }
 
 }

test/commands/registration/retr.spec.js

@@ -2,13 +2,11 @@ const Promise = require('bluebird');
 const bunyan = require('bunyan');
 const {expect} = require('chai');
 const sinon = require('sinon');
-const EventEmitter = require('events');
 
 const CMD = 'RETR';
 describe(CMD, function () {
   let sandbox;
   let log = bunyan.createLogger({name: CMD});
-  let emitter;
   const mockClient = {
     commandSocket: {
       pause: () => {},
@@ -31,11 +29,6 @@ describe(CMD, function () {
       read: () => {}
     };
 
-    emitter = new EventEmitter();
-    mockClient.emit = emitter.emit.bind(emitter);
-    mockClient.on = emitter.on.bind(emitter);
-    mockClient.once = emitter.once.bind(emitter);
-
     sandbox.spy(mockClient, 'reply');
   });
   afterEach(() => sandbox.restore());
@@ -63,7 +56,6 @@ describe(CMD, function () {
       return Promise.reject(new Promise.TimeoutError());
     });
 
-
     return cmdFn({log, command: {arg: 'test.txt'}})
     .then(() => {
       expect(mockClient.reply.args[0][0]).to.equal(425);
@@ -80,20 +72,4 @@ describe(CMD, function () {
       expect(mockClient.reply.args[0][0]).to.equal(551);
     });
   });
-
-  it('// unsuccessful | emits error event', () => {
-    sandbox.stub(mockClient.connector, 'waitForConnection').callsFake(function () {
-      return Promise.reject(new Error('test'));
-    });
-
-    let errorEmitted = false;
-    emitter.once('RETR', err => {
-      errorEmitted = !!err;
-    });
-
-    return cmdFn({log, command: {arg: 'test.txt'}})
-    .then(() => {
-      expect(errorEmitted).to.equal(true);
-    });
-  });
 });

test/commands/registration/stor.spec.js

@@ -2,13 +2,11 @@ const Promise = require('bluebird');
 const bunyan = require('bunyan');
 const {expect} = require('chai');
 const sinon = require('sinon');
-const EventEmitter = require('events');
 
 const CMD = 'STOR';
 describe(CMD, function () {
   let sandbox;
   let log = bunyan.createLogger({name: CMD});
-  let emitter;
   const mockClient = {
     commandSocket: {
       pause: () => {},
@@ -31,11 +29,6 @@ describe(CMD, function () {
       write: () => {}
     };
 
-    emitter = new EventEmitter();
-    mockClient.emit = emitter.emit.bind(emitter);
-    mockClient.on = emitter.on.bind(emitter);
-    mockClient.once = emitter.once.bind(emitter);
-
     sandbox.spy(mockClient, 'reply');
   });
   afterEach(() => sandbox.restore());
@@ -79,20 +72,4 @@ describe(CMD, function () {
       expect(mockClient.reply.args[0][0]).to.equal(550);
     });
   });
-
-  it('// unsuccessful | emits error event', () => {
-    sandbox.stub(mockClient.connector, 'waitForConnection').callsFake(function () {
-      return Promise.reject(new Error('test'));
-    });
-
-    let errorEmitted = false;
-    emitter.once('STOR', err => {
-      errorEmitted = !!err;
-    });
-
-    return cmdFn({log, command: {arg: 'test.txt'}})
-    .then(() => {
-      expect(errorEmitted).to.equal(true);
-    });
-  });
 });

test/connector/passive.spec.js

@@ -64,7 +64,7 @@ describe('Connector - Passive //', function () {
     return passive.setupServer()
     .then(shouldNotResolve)
     .catch(err => {
-      expect(err).to.be.instanceOf(RangeError);
+      expect(err.name).to.equal('RangeError');
     });
   });
 

test/helpers/file-stat.spec.js

@@ -1,20 +1,9 @@
 const {expect} = require('chai');
-const sinon = require('sinon');
-const moment = require('moment');
 
 const fileStat = require('../../src/helpers/file-stat');
 const errors = require('../../src/errors');
 
 describe('helpers // file-stat', function () {
-  let sandbox;
-
-  before(function () {
-    sandbox = sinon.sandbox.create();
-  });
-  afterEach(function () {
-    sandbox.restore();
-  });
-
   const STAT = {
     name: 'test1',
     dev: 2114,
@@ -55,11 +44,6 @@ describe('helpers // file-stat', function () {
 
   describe('format - ls //', function () {
     it('formats correctly', () => {
-      const momentStub = sandbox.stub(moment, 'utc').callThrough();
-      momentStub.onFirstCall().callsFake(function () {
-        return moment.utc(new Date('Sept 10 2016'));
-      });
-
       const format = fileStat(STAT, 'ls');
       expect(format).to.equal('-rwxrwxrwx 1 85 100          527 Oct 10 23:24 test1');
     });

test/index.spec.js

@@ -189,11 +189,6 @@ describe('Integration', function () {
     it('STOR tést.txt', done => {
       const buffer = Buffer.from('test text file');
       const fsPath = `${clientDirectory}/${name}/tést.txt`;
-
-      connection.once('STOR', err => {
-        expect(err).to.not.exist;
-      });
-
       client.put(buffer, 'tést.txt', err => {
         expect(err).to.not.exist;
         setTimeout(() => {
@@ -224,10 +219,6 @@ describe('Integration', function () {
     });
 
     it('RETR tést.txt', done => {
-      connection.once('RETR', err => {
-        expect(err).to.not.exist;
-      });
-
       client.get('tést.txt', (err, stream) => {
         expect(err).to.not.exist;
         let text = '';

test/mochabunyan.opts

@@ -0,0 +1,5 @@
+{
+  "mute":false,
+  "level":"debug",
+  "reporter":"spec"
+}