From 33aaafa637c53dbef6f11d8edf5225be44fbd6b7 Mon Sep 17 00:00:00 2001 From: benjaminJ Date: Wed, 18 Jan 2017 18:11:52 +0100 Subject: [PATCH] Readme update (displayHidden option) + bump version number --- README.md | 37 +++++++++++++++++++++++++------------ package.json | 4 ++-- 2 files changed, 27 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index c98912b..e34fe29 100644 --- a/README.md +++ b/README.md @@ -6,17 +6,17 @@ This project is a fork of [Inquirer-directory](https://github.com/nicksrandall/i ![](https://img.shields.io/badge/license-MIT-blue.svg) -[![](https://img.shields.io/badge/release-v1.0.2-blue.svg)](https://github.com/KamiKillertO/inquirer-select-directory/releases/tag/v1.0.2) +[![](https://img.shields.io/badge/release-v1.1.0-blue.svg)](https://github.com/KamiKillertO/inquirer-select-directory/releases/tag/v1.1.0) [![Build Status](https://travis-ci.org/KamiKillertO/inquirer-select-directory.svg)](https://travis-ci.org/KamiKillertO/inquirer-select-directory) [![Build status](https://ci.appveyor.com/api/projects/status/fdyk5g3y56381742?svg=true)](https://ci.appveyor.com/project/KamiKillertO/inquirer-select-directory) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/e6a963539c4440b69356649c0048ea30)](https://www.codacy.com/app/kamikillerto/inquirer-select-directory?utm_source=github.com&utm_medium=referral&utm_content=KamiKillertO/inquirer-select-directory&utm_campaign=Badge_Grade) - + ## Features - Support for symlinked files @@ -46,13 +46,13 @@ Change `directory` to whatever you might prefer. ### Options -Takes `type`, `name`, `message`, `basePath` properties. +Takes `type`, `name`, `message`, `basePath`, `options` properties. See [inquirer](https://github.com/SBoudrias/Inquirer.js) readme for meaning of all except **basePath**. **basePath** is the relative path from your current working directory -#### Example +#### [Example](https://github.com/KamiKillertO/inquirer-select-directory/tree/develop/example/example.js) ```javascript inquirer.registerPrompt('directory', require('inquirer-directory')); @@ -61,16 +61,29 @@ inquirer.prompt([{ name: 'from', message: 'Where you like to put this component?', basePath: './src' -}], function(answers) { +}]).then(function(answers) { //etc }); ``` - - + +#### options.displayHidden + +default ***false*** + +Set this to true if you to display hidden folders + +```javascript +inquirer.prompt([{ + type: 'directory', + //... + options: { + displayHidden:true + } +}]).then(function(answers) { + //etc +}); +``` + ## License MIT \ No newline at end of file diff --git a/package.json b/package.json index 912ecb8..0f2fe75 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "inquirer-select-directory", - "version": "1.0.2", + "version": "1.1.0", "description": "A directory prompt for Inquirer.js", "main": "src/index.js", "scripts": { @@ -39,4 +39,4 @@ "mock-fs": "3.12.1", "sinon": "1.17.2" } -} +} \ No newline at end of file