Skip to content

Commit

Permalink
BREAKING: Do not resolve "directories"-property in preprocessor
Browse files Browse the repository at this point in the history
Prior to this commit, the files in the directories referenced in the
directories-property of the package.json, would be read and included
into an object structure.
This is not necessary anymore, since there are now (for a long time
already) promise-based helpers that can read files.
  • Loading branch information
nknapp committed Mar 19, 2017
1 parent d7e0f94 commit 8f2cc3b
Show file tree
Hide file tree
Showing 15 changed files with 170 additions and 20 deletions.
8 changes: 7 additions & 1 deletion handlebars/partials/license.md.hbs
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
## License

`{{{package.name}}}` is published under the {{{package.license}}}-license.
`{{{package.name}}}` is published under the {{{package.license}}}-license.

{{#if licenseFile}}
See [{{{licenseFile.filename}}}]({{{licenseFile.filename}}}) for details.
{{else}}
No file "LICENSE*" found
{{/if}}

13 changes: 0 additions & 13 deletions handlebars/preprocessor.js
Original file line number Diff line number Diff line change
Expand Up @@ -13,19 +13,6 @@ var debug = require('debug')('thought:preprocessor')
*/
module.exports = function (data) {
data = _.cloneDeep(data)
var exampleDir = data.package.directories && data.package.directories.example
if (exampleDir) {
// Resolve
data.directories = qfs.list(exampleDir)
.then(function (list) {
return list.map(function (filename) {
return {
path: path.join(exampleDir, filename),
filename: filename
}
})
})
}

// Detect license file and read contents
debug('workingdir', data.workingDir)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,10 @@ This is the example output 123

## License

`simple-project` is published under the ISC-license.
See []() for details.
`simple-project` is published under the ISC-license.

No file "LICENSE*" found



## Contributing guidelines
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
## Contributing

Contributions and feedback are always welcome. The expected procedure is the following:

### Bugs, Features and Feedback

* Please, create github issues for **feature-requests**, **bug reports**.
* Feel free to open issues for **questions and problems you have**, even if they are not bugs
or feature requests.
* You may even open an issue just to say you like the project.
* For small changes, such as **typo and formatting corrections**, you can immediately
create a pull-request. You can use the github web-interface, but keep in mind that most of the documentation
is created with Thought, so you should change the template in the `.thought` directory or change the default
templates in [the thought project](https://github.com/nknapp/thought/tree/master/handlebars).
* If you have an idea for a **new feature** that you would like to implement, please **open an issue** first and ask
for feedback. Maybe someone else has a similar problem and different ideas.
* If you encounter a bug you can submit a **pull-request for a failing unit test**, you should then also open an issue
for the bug.
* Before making a pull-request, make sure that you commit corresponds to the coding-style. You can do this by
running `npm test`.

**People submitting relevant contributions will be granted commit access to the repository.**


### Coding style

[![standard][standard-image]][standard-url]

This repository uses [`standard`][standard-url] to maintain code style and consistency,
and to avoid style arguments. You can run `npm run format` to apply the coding-style, but
you may need to fix some things manually. Make sure to use the latest version of `standard`.


### Installing & Testing

You can fork and clone the repo from github. Run

* Run `npm install` to install all the dependencies needed to build and run the project.
* Run `npm test` to run unit tests and validate the `standard` coding-style.

It is intentional to don't have `standard`, `thought`, `istanbul` and `coveralls` in the devDependencies.
`standard` is a rather large package which you would not want to have copied into the `node_modules`-folder
of each of your projects.

Instead, the `pretest`- and `preformat`-scripts ensure that `standard` and `thought` are installed globally.
If you are not allowed to install packages globally, please raise an issue, so that we can try to find a solution.


### About this text

This text is part of the [Thought](https://github.com/nknapp/thought)-project. If you have any suggestions or wishes
to change the text, please raise an issue there for discussion.

[standard-image]: https://cdn.rawgit.com/feross/standard/master/badge.svg
[standard-url]: https://github.com/feross/standard
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
This is the license
42 changes: 42 additions & 0 deletions test/fixtures/scenarios/project-with-license/expected/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# simple-project

[![NPM version](https://badge.fury.io/js/simple-project.svg)](http://badge.fury.io/js/simple-project)


> A simple description

# Installation

```
npm install simple-project
```


## Usage

The following example demonstrates how to use this module:

```js
console.log("This is the example output 123")
```

This will generate the following output

```
This is the example output 123
```



## License

`simple-project` is published under the ISC-license.

See [LICENSE.md](LICENSE.md) for details.



## Contributing guidelines

See [CONTRIBUTING.md](CONTRIBUTING.md).
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
console.log("This is the example output 123")
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
/**
* Beschreibung
* @param {string=} param
*/
function abc(param) {

}
18 changes: 18 additions & 0 deletions test/fixtures/scenarios/project-with-license/expected/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
"name": "simple-project",
"version": "1.0.0",
"description": "A simple description",
"main": "index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"repository": {
"type": "git",
"url": "https://github.com/unit-test/project-with-example.git"
},
"author": "",
"license": "ISC",
"devDependencies": {
"fs-walker": "^1.0.0"
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
This is the license
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
console.log("This is the example output 123")
7 changes: 7 additions & 0 deletions test/fixtures/scenarios/project-with-license/input/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
/**
* Beschreibung
* @param {string=} param
*/
function abc(param) {

}
18 changes: 18 additions & 0 deletions test/fixtures/scenarios/project-with-license/input/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
"name": "simple-project",
"version": "1.0.0",
"description": "A simple description",
"main": "index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"repository": {
"type": "git",
"url": "https://github.com/unit-test/project-with-example.git"
},
"author": "",
"license": "ISC",
"devDependencies": {
"fs-walker": "^1.0.0"
}
}
6 changes: 4 additions & 2 deletions test/fixtures/scenarios/simple-project/expected/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,10 @@ npm install simple-project

## License

`simple-project` is published under the ISC-license.
See []() for details.
`simple-project` is published under the ISC-license.

No file "LICENSE*" found



## Contributing guidelines
Expand Down
6 changes: 4 additions & 2 deletions test/fixtures/scenarios/with-greenkeeper/expected/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,10 @@ npm install simple-project

## License

`simple-project` is published under the ISC-license.
See []() for details.
`simple-project` is published under the ISC-license.

No file "LICENSE*" found



## Contributing guidelines
Expand Down

0 comments on commit 8f2cc3b

Please sign in to comment.