├── .editorconfig ├── .eslintrc.json ├── .gitattributes ├── .gitignore ├── .travis.yml ├── .verb.md ├── LICENSE ├── README.md ├── index.js ├── package.json └── test.js /.editorconfig: -------------------------------------------------------------------------------- 1 | # http://editorconfig.org 2 | root = true 3 | 4 | [*] 5 | indent_style = space 6 | end_of_line = lf 7 | charset = utf-8 8 | indent_size = 2 9 | trim_trailing_whitespace = true 10 | insert_final_newline = true 11 | 12 | [*.md] 13 | trim_trailing_whitespace = false 14 | insert_final_newline = false 15 | 16 | [test/**] 17 | trim_trailing_whitespace = false 18 | insert_final_newline = false 19 | 20 | [templates/**] 21 | trim_trailing_whitespace = false 22 | insert_final_newline = false 23 | -------------------------------------------------------------------------------- /.eslintrc.json: -------------------------------------------------------------------------------- 1 | { 2 | "ecmaFeatures": { 3 | "modules": true, 4 | "experimentalObjectRestSpread": true 5 | }, 6 | "env": { 7 | "browser": false, 8 | "es6": true, 9 | "node": true, 10 | "mocha": true 11 | }, 12 | "globals": { 13 | "document": false, 14 | "navigator": false, 15 | "window": false 16 | }, 17 | "rules": { 18 | "accessor-pairs": 2, 19 | "arrow-spacing": [ 20 | 2, 21 | { 22 | "before": true, 23 | "after": true 24 | } 25 | ], 26 | "block-spacing": [ 27 | 2, 28 | "always" 29 | ], 30 | "brace-style": [ 31 | 2, 32 | "1tbs", 33 | { 34 | "allowSingleLine": true 35 | } 36 | ], 37 | "comma-dangle": [ 38 | 2, 39 | "never" 40 | ], 41 | "comma-spacing": [ 42 | 2, 43 | { 44 | "before": false, 45 | "after": true 46 | } 47 | ], 48 | "comma-style": [ 49 | 2, 50 | "last" 51 | ], 52 | "constructor-super": 2, 53 | "curly": [ 54 | 2, 55 | "multi-line" 56 | ], 57 | "dot-location": [ 58 | 2, 59 | "property" 60 | ], 61 | "eol-last": 2, 62 | "eqeqeq": [ 63 | 2, 64 | "allow-null" 65 | ], 66 | "generator-star-spacing": [ 67 | 2, 68 | { 69 | "before": true, 70 | "after": true 71 | } 72 | ], 73 | "handle-callback-err": [ 74 | 2, 75 | "^(err|error)$" 76 | ], 77 | "indent": [ 78 | 2, 79 | 2, 80 | { 81 | "SwitchCase": 1 82 | } 83 | ], 84 | "key-spacing": [ 85 | 2, 86 | { 87 | "beforeColon": false, 88 | "afterColon": true 89 | } 90 | ], 91 | "keyword-spacing": [ 92 | 2, 93 | { 94 | "before": true, 95 | "after": true 96 | } 97 | ], 98 | "new-cap": [ 99 | 2, 100 | { 101 | "newIsCap": true, 102 | "capIsNew": false 103 | } 104 | ], 105 | "new-parens": 2, 106 | "no-array-constructor": 2, 107 | "no-caller": 2, 108 | "no-class-assign": 2, 109 | "no-cond-assign": 2, 110 | "no-const-assign": 2, 111 | "no-control-regex": 2, 112 | "no-debugger": 2, 113 | "no-delete-var": 2, 114 | "no-dupe-args": 2, 115 | "no-dupe-class-members": 2, 116 | "no-dupe-keys": 2, 117 | "no-duplicate-case": 2, 118 | "no-empty-character-class": 2, 119 | "no-eval": 2, 120 | "no-ex-assign": 2, 121 | "no-extend-native": 2, 122 | "no-extra-bind": 2, 123 | "no-extra-boolean-cast": 2, 124 | "no-extra-parens": [ 125 | 2, 126 | "functions" 127 | ], 128 | "no-fallthrough": 2, 129 | "no-floating-decimal": 2, 130 | "no-func-assign": 2, 131 | "no-implied-eval": 2, 132 | "no-inner-declarations": [ 133 | 2, 134 | "functions" 135 | ], 136 | "no-invalid-regexp": 2, 137 | "no-irregular-whitespace": 2, 138 | "no-iterator": 2, 139 | "no-label-var": 2, 140 | "no-labels": 2, 141 | "no-lone-blocks": 2, 142 | "no-mixed-spaces-and-tabs": 2, 143 | "no-multi-spaces": 2, 144 | "no-multi-str": 2, 145 | "no-multiple-empty-lines": [ 146 | 2, 147 | { 148 | "max": 1 149 | } 150 | ], 151 | "no-native-reassign": 0, 152 | "no-negated-in-lhs": 2, 153 | "no-new": 2, 154 | "no-new-func": 2, 155 | "no-new-object": 2, 156 | "no-new-require": 2, 157 | "no-new-wrappers": 2, 158 | "no-obj-calls": 2, 159 | "no-octal": 2, 160 | "no-octal-escape": 2, 161 | "no-proto": 0, 162 | "no-redeclare": 2, 163 | "no-regex-spaces": 2, 164 | "no-return-assign": 2, 165 | "no-self-compare": 2, 166 | "no-sequences": 2, 167 | "no-shadow-restricted-names": 2, 168 | "no-spaced-func": 2, 169 | "no-sparse-arrays": 2, 170 | "no-this-before-super": 2, 171 | "no-throw-literal": 2, 172 | "no-trailing-spaces": 0, 173 | "no-undef": 2, 174 | "no-undef-init": 2, 175 | "no-unexpected-multiline": 2, 176 | "no-unneeded-ternary": [ 177 | 2, 178 | { 179 | "defaultAssignment": false 180 | } 181 | ], 182 | "no-unreachable": 2, 183 | "no-unused-vars": [ 184 | 2, 185 | { 186 | "vars": "all", 187 | "args": "none" 188 | } 189 | ], 190 | "no-useless-call": 0, 191 | "no-with": 2, 192 | "one-var": [ 193 | 0, 194 | { 195 | "initialized": "never" 196 | } 197 | ], 198 | "operator-linebreak": [ 199 | 0, 200 | "after", 201 | { 202 | "overrides": { 203 | "?": "before", 204 | ":": "before" 205 | } 206 | } 207 | ], 208 | "padded-blocks": [ 209 | 0, 210 | "never" 211 | ], 212 | "quotes": [ 213 | 2, 214 | "single", 215 | "avoid-escape" 216 | ], 217 | "radix": 2, 218 | "semi": [ 219 | 2, 220 | "always" 221 | ], 222 | "semi-spacing": [ 223 | 2, 224 | { 225 | "before": false, 226 | "after": true 227 | } 228 | ], 229 | "space-before-blocks": [ 230 | 2, 231 | "always" 232 | ], 233 | "space-before-function-paren": [ 234 | 2, 235 | "never" 236 | ], 237 | "space-in-parens": [ 238 | 2, 239 | "never" 240 | ], 241 | "space-infix-ops": 2, 242 | "space-unary-ops": [ 243 | 2, 244 | { 245 | "words": true, 246 | "nonwords": false 247 | } 248 | ], 249 | "spaced-comment": [ 250 | 0, 251 | "always", 252 | { 253 | "markers": [ 254 | "global", 255 | "globals", 256 | "eslint", 257 | "eslint-disable", 258 | "*package", 259 | "!", 260 | "," 261 | ] 262 | } 263 | ], 264 | "use-isnan": 2, 265 | "valid-typeof": 2, 266 | "wrap-iife": [ 267 | 2, 268 | "any" 269 | ], 270 | "yoda": [ 271 | 2, 272 | "never" 273 | ] 274 | } 275 | } 276 | -------------------------------------------------------------------------------- /.gitattributes: -------------------------------------------------------------------------------- 1 | # Enforce Unix newlines 2 | * text eol=lf 3 | 4 | # binaries 5 | *.ai binary 6 | *.psd binary 7 | *.jpg binary 8 | *.gif binary 9 | *.png binary 10 | *.jpeg binary 11 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # always ignore files 2 | *.DS_Store 3 | *.sublime-* 4 | 5 | # test related, or directories generated by tests 6 | test/actual 7 | actual 8 | coverage 9 | 10 | # npm 11 | node_modules 12 | npm-debug.log 13 | 14 | # misc 15 | _gh_pages 16 | benchmark 17 | bower_components 18 | vendor 19 | temp 20 | tmp 21 | TODO.md 22 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | sudo: false 2 | language: node_js 3 | node_js: 4 | - '5' 5 | - '4' 6 | - '0.12' 7 | - '0.10' 8 | matrix: 9 | fast_finish: true 10 | allow_failures: 11 | - node_js: '0.10' 12 | - node_js: '0.12' 13 | -------------------------------------------------------------------------------- /.verb.md: -------------------------------------------------------------------------------- 1 | ## Usage 2 | 3 | ```js 4 | var project = require('{%= name %}'); 5 | var Base = require('base'); 6 | var base = new Base(); 7 | 8 | base.use(project()); 9 | ``` 10 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | The MIT License (MIT) 2 | 3 | Copyright (c) 2016, Jon Schlinkert. 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in 13 | all copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 21 | THE SOFTWARE. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # base-project [![NPM version](https://img.shields.io/npm/v/base-project.svg?style=flat)](https://www.npmjs.com/package/base-project) [![NPM downloads](https://img.shields.io/npm/dm/base-project.svg?style=flat)](https://npmjs.org/package/base-project) [![Build Status](https://img.shields.io/travis/node-base/base-project.svg?style=flat)](https://travis-ci.org/node-base/base-project) 2 | 3 | Base plugin that adds a `project` getter to the instance for getting the name of a project. Gets the project name for new (empty) projects, projects with only a .git repository, and/or projects with a package.json. 4 | 5 | ## Install 6 | 7 | Install with [npm](https://www.npmjs.com/): 8 | 9 | ```sh 10 | $ npm install base-project --save 11 | ``` 12 | 13 | ## Usage 14 | 15 | ```js 16 | var project = require('base-project'); 17 | var Base = require('base'); 18 | var base = new Base(); 19 | 20 | base.use(project()); 21 | ``` 22 | 23 | ## Related projects 24 | 25 | You might also be interested in these projects: 26 | 27 | * [base-cwd](https://www.npmjs.com/package/base-cwd): Base plugin that adds a getter/setter for the current working directory. | [homepage](https://github.com/node-base/base-cwd) 28 | * [base-data](https://www.npmjs.com/package/base-data): adds a `data` method to base-methods. | [homepage](https://github.com/node-base/base-data) 29 | * [base-option](https://www.npmjs.com/package/base-option): Adds a few options methods to base, like `option`, `enable` and `disable`. See the readme… [more](https://www.npmjs.com/package/base-option) | [homepage](https://github.com/node-base/base-option) 30 | * [base-pkg](https://www.npmjs.com/package/base-pkg): Plugin for adding a `pkg` method that exposes pkg-store to your base application. | [homepage](https://github.com/node-base/base-pkg) 31 | 32 | ## Contributing 33 | 34 | Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/node-base/base-project/issues/new). 35 | 36 | ## Building docs 37 | 38 | Generate readme and API documentation with [verb](https://github.com/verbose/verb): 39 | 40 | ```sh 41 | $ npm install verb && npm run docs 42 | ``` 43 | 44 | Or, if [verb](https://github.com/verbose/verb) is installed globally: 45 | 46 | ```sh 47 | $ verb 48 | ``` 49 | 50 | ## Running tests 51 | 52 | Install dev dependencies: 53 | 54 | ```sh 55 | $ npm install -d && npm test 56 | ``` 57 | 58 | ## Author 59 | 60 | **Jon Schlinkert** 61 | 62 | * [github/jonschlinkert](https://github.com/jonschlinkert) 63 | * [twitter/jonschlinkert](http://twitter.com/jonschlinkert) 64 | 65 | ## License 66 | 67 | Copyright © 2016, [Jon Schlinkert](https://github.com/jonschlinkert). 68 | Released under the [MIT license](https://github.com/node-base/base-project/blob/master/LICENSE). 69 | 70 | *** 71 | 72 | _This file was generated by [verb](https://github.com/verbose/verb), v0.9.0, on May 15, 2016._ -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | /*! 2 | * base-project 3 | * 4 | * Copyright (c) 2016, Jon Schlinkert. 5 | * Licensed under the MIT License. 6 | */ 7 | 8 | 'use strict'; 9 | 10 | var isValidInstance = require('is-valid-instance'); 11 | var isRegistered = require('is-registered'); 12 | var project = require('project-name'); 13 | 14 | module.exports = function(fn) { 15 | return function(app) { 16 | if (!isValid(app, fn)) return; 17 | 18 | var name; 19 | this.define('project', { 20 | configurable: true, 21 | enumerable: true, 22 | set: function(val) { 23 | name = val; 24 | }, 25 | get: function() { 26 | return name || (name = project(this.cwd)); 27 | } 28 | }); 29 | }; 30 | }; 31 | 32 | function isValid(app, fn) { 33 | if (typeof fn === 'function') { 34 | return fn(app); 35 | } 36 | if (!isValidInstance(app)) { 37 | return false; 38 | } 39 | if (isRegistered(app, 'base-project')) { 40 | return false; 41 | } 42 | return true; 43 | } 44 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "base-project", 3 | "description": "Base plugin that adds a `project` getter to the instance for getting the name of a project. Gets the project name for new (empty) projects, projects with only a .git repository, and/or projects with a package.json.", 4 | "version": "0.2.1", 5 | "homepage": "https://github.com/node-base/base-project", 6 | "author": "Jon Schlinkert (https://github.com/jonschlinkert)", 7 | "repository": "node-base/base-project", 8 | "bugs": { 9 | "url": "https://github.com/node-base/base-project/issues" 10 | }, 11 | "license": "MIT", 12 | "files": [ 13 | "index.js" 14 | ], 15 | "main": "index.js", 16 | "engines": { 17 | "node": ">=0.10.0" 18 | }, 19 | "scripts": { 20 | "test": "mocha" 21 | }, 22 | "dependencies": { 23 | "is-registered": "^0.1.3", 24 | "is-valid-instance": "^0.1.0", 25 | "project-name": "^0.2.5" 26 | }, 27 | "devDependencies": { 28 | "base": "^0.8.1", 29 | "gulp-format-md": "^0.1.9", 30 | "mocha": "^2.4.5" 31 | }, 32 | "keywords": [ 33 | "base", 34 | "base-plugin", 35 | "baseplugin", 36 | "create", 37 | "empty", 38 | "generator", 39 | "init", 40 | "name", 41 | "plugin", 42 | "project", 43 | "repository" 44 | ], 45 | "lintDeps": { 46 | "ignore": [] 47 | }, 48 | "verb": { 49 | "run": true, 50 | "toc": false, 51 | "layout": "default", 52 | "tasks": [ 53 | "readme" 54 | ], 55 | "plugins": [ 56 | "gulp-format-md" 57 | ], 58 | "related": { 59 | "list": [ 60 | "base-cwd", 61 | "base-data", 62 | "base-option", 63 | "base-pkg" 64 | ] 65 | }, 66 | "reflinks": [ 67 | "verb" 68 | ], 69 | "lint": { 70 | "reflinks": true 71 | } 72 | } 73 | } 74 | -------------------------------------------------------------------------------- /test.js: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | 3 | require('mocha'); 4 | var assert = require('assert'); 5 | var Base = require('base'); 6 | var base; 7 | 8 | var project = require('./'); 9 | 10 | describe('base-project', function() { 11 | describe('plugin', function() { 12 | it('should export a function', function() { 13 | assert.equal(typeof project, 'function'); 14 | }); 15 | 16 | it('should register as a plugin', function() { 17 | base = new Base(); 18 | base.isApp = true; 19 | base.use(project()); 20 | assert(base.registered.hasOwnProperty('base-project')); 21 | }); 22 | 23 | it('should expose a project getter/setter', function() { 24 | base = new Base(); 25 | base.isApp = true; 26 | base.use(project()); 27 | assert.equal(typeof base.project, 'string'); 28 | }); 29 | 30 | it('should set the name of the project', function() { 31 | base = new Base(); 32 | base.isApp = true; 33 | base.use(project()); 34 | assert.equal(base.project, 'base-project'); 35 | }); 36 | 37 | it('should allow a validation fn to be defined', function() { 38 | base = new Base(); 39 | base.use(project(function(app) { 40 | return app.isFoo; 41 | })); 42 | assert(!base.project); 43 | 44 | base.isFoo = true; 45 | base.use(project(function(app) { 46 | return app.isFoo; 47 | })); 48 | assert.equal(base.project, 'base-project'); 49 | }); 50 | }); 51 | }); 52 | --------------------------------------------------------------------------------