├── .editorconfig ├── .flowconfig ├── .gitattributes ├── .gitignore ├── .npmignore ├── .prettierignore ├── CODING-STANDARDS.md ├── CONTRIBUTING.md ├── HISTORY.md ├── LICENSE.md └── README.md /.editorconfig: -------------------------------------------------------------------------------- 1 | # 2023 June 22 2 | # https://github.com/bevry/base 3 | 4 | root = true 5 | 6 | [*] 7 | end_of_line = lf 8 | charset = utf-8 9 | trim_trailing_whitespace = true 10 | insert_final_newline = false 11 | indent_style = tab 12 | 13 | [{*.mk,*.py}] 14 | indent_style = tab 15 | indent_size = 4 16 | 17 | [*.md] 18 | indent_style = space 19 | indent_size = 4 20 | 21 | [{*.json,*.lsrules,*.yaml,*.yml,*.bowerrc,*.babelrc,*.code-workspace}] 22 | indent_style = space 23 | indent_size = 2 24 | 25 | [{*.json,*.lsrules}] 26 | insert_final_newline = true 27 | -------------------------------------------------------------------------------- /.flowconfig: -------------------------------------------------------------------------------- 1 | # 2018 November 15 2 | # https://github.com/bevry/base 3 | [ignore] 4 | .*/docs/.* 5 | .*/edition*/.* 6 | .*/test/.* 7 | .*/node_modules/documentation/.* 8 | .*/node_modules/projectz/.* 9 | 10 | [options] 11 | module.ignore_non_literal_requires=true 12 | esproposal.class_static_fields=enable 13 | esproposal.class_instance_fields=enable 14 | 15 | [version] 16 | >=0.23 <1 17 | -------------------------------------------------------------------------------- /.gitattributes: -------------------------------------------------------------------------------- 1 | # 2024 January 3 2 | # https://github.com/bevry/base 3 | 4 | # never modify any line ending in any file, disregarding all nonsense from eol, autocrlf, renormalize, safecrlf, usecrlfattr, allBinary 5 | * -text 6 | 7 | # ===================================== 8 | # CUSTOM 9 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # 2020 June 3 2 | # https://github.com/bevry/base 3 | 4 | # System Files 5 | **/.DS_Store 6 | 7 | # Temp Files 8 | **/.docpad.db 9 | **/*.log 10 | **/*.cpuprofile 11 | **/*.heapsnapshot 12 | 13 | # Editor Files 14 | .c9/ 15 | .vscode/ 16 | 17 | # Yarn Files 18 | .yarn/* 19 | !.yarn/releases 20 | !.yarn/plugins 21 | !.yarn/sdks 22 | !.yarn/versions 23 | .pnp.* 24 | .pnp/ 25 | 26 | # Private Files 27 | .env 28 | .idea 29 | .cake_task_cache 30 | 31 | # Build Caches 32 | build/ 33 | bower_components/ 34 | node_modules/ 35 | .next/ 36 | 37 | # ------------------------------------- 38 | # CDN Inclusions, Git Exclusions 39 | 40 | # Build Outputs 41 | **/out.* 42 | **/*.out.* 43 | **/out/ 44 | **/output/ 45 | *compiled* 46 | edition*/ 47 | coffeejs/ 48 | coffee/ 49 | es5/ 50 | es2015/ 51 | esnext/ 52 | docs/ 53 | 54 | # ===================================== 55 | # CUSTOM 56 | 57 | .now 58 | -------------------------------------------------------------------------------- /.npmignore: -------------------------------------------------------------------------------- 1 | # 2020 May 5 2 | # https://github.com/bevry/base 3 | 4 | # System Files 5 | **/.DS_Store 6 | 7 | # Temp Files 8 | **/.docpad.db 9 | **/*.log 10 | **/*.cpuprofile 11 | **/*.heapsnapshot 12 | 13 | # Editor Files 14 | .c9/ 15 | .vscode/ 16 | 17 | # Private Files 18 | .env 19 | .idea 20 | .cake_task_cache 21 | 22 | # Build Caches 23 | build/ 24 | components/ 25 | bower_components/ 26 | node_modules/ 27 | .pnp/ 28 | .pnp.js 29 | 30 | # Ecosystem Files 31 | .dependabout 32 | .github 33 | 34 | # ------------------------------------- 35 | # CDN Inclusions, Package Exclusions 36 | 37 | # Documentation Files 38 | docs/ 39 | guides/ 40 | BACKERS.md 41 | CONTRIBUTING.md 42 | HISTORY.md 43 | 44 | # Development Files 45 | web/ 46 | **/example* 47 | **/test* 48 | .babelrc* 49 | .editorconfig 50 | .eslintrc* 51 | .jshintrc 52 | .jscrc 53 | coffeelint* 54 | .travis* 55 | nakefile* 56 | Cakefile 57 | Makefile 58 | 59 | # Other Package Definitions 60 | template.js 61 | component.json 62 | bower.json 63 | 64 | # ===================================== 65 | # CUSTOM 66 | 67 | # None 68 | -------------------------------------------------------------------------------- /.prettierignore: -------------------------------------------------------------------------------- 1 | # 2023 November 13 2 | # https://github.com/bevry/base 3 | 4 | # VCS Files 5 | .git 6 | .svn 7 | .hg 8 | 9 | # System Files 10 | **/.DS_Store 11 | 12 | # Temp Files 13 | **/.docpad.db 14 | **/*.log 15 | **/*.cpuprofile 16 | **/*.heapsnapshot 17 | 18 | # Yarn Files 19 | .yarn/* 20 | !.yarn/releases 21 | !.yarn/plugins 22 | !.yarn/sdks 23 | !.yarn/versions 24 | .pnp.* 25 | .pnp/ 26 | 27 | # Build Caches 28 | build/ 29 | components/ 30 | bower_components/ 31 | node_modules/ 32 | 33 | # Build Outputs 34 | **/*.cjs 35 | **/*.mjs 36 | **/out.* 37 | **/*.out.* 38 | **/out/ 39 | **/output/ 40 | *compiled* 41 | edition*/ 42 | coffeejs/ 43 | coffee/ 44 | es5/ 45 | es2015/ 46 | esnext/ 47 | docs/ 48 | 49 | # Development Files 50 | test/ 51 | **/*fixtures* 52 | 53 | # Ecosystem Caches 54 | .trunk/*/ 55 | 56 | # ===================================== 57 | # CUSTOM 58 | 59 | # None 60 | -------------------------------------------------------------------------------- /CODING-STANDARDS.md: -------------------------------------------------------------------------------- 1 | # [Moved](https://learn.bevry.me/community/coding-standards/) 2 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | 5 | 6 | # Before You Post! 7 | 8 | ## Support 9 | 10 | We offer support through our [Official Support Channels](https://bevry.me/support). Do not use GitHub Issues for support, your issue will be closed. 11 | 12 | ## Contribute 13 | 14 | Our [Contributing Guide](https://bevry.me/contribute) contains useful tips and suggestions for how to contribute to this project, it's worth the read. 15 | 16 | ## Development 17 | 18 | ### Setup 19 | 20 | 1. [Install Node.js](https://bevry.me/install/node) 21 | 22 | 1. Fork the project and clone your fork - [guide](https://help.github.com/articles/fork-a-repo/) 23 | 24 | 1. Setup the project for development 25 | 26 | ```bash 27 | npm run our:setup 28 | ``` 29 | 30 | ### Developing 31 | 32 | 1. Compile changes 33 | 34 | ```bash 35 | npm run our:compile 36 | ``` 37 | 38 | 1. Run tests 39 | 40 | ```bash 41 | npm test 42 | ``` 43 | 44 | ### Publishing 45 | 46 | Follow these steps in order to implement your changes/improvements into your desired project: 47 | 48 | #### Preparation 49 | 50 | 1. Make sure your changes are on their own branch that is branched off from master. 51 | 52 | 1. You can do this by: `git checkout master; git checkout -b your-new-branch` 53 | 1. And push the changes up by: `git push origin your-new-branch` 54 | 55 | 1. Ensure all tests pass: 56 | 57 | ```bash 58 | npm test 59 | ``` 60 | 61 | > If possible, add tests for your change, if you don't know how, mention this in your pull request 62 | 63 | 1. Ensure the project is ready for publishing: 64 | 65 | ``` 66 | npm run our:release:prepare 67 | ``` 68 | 69 | #### Pull Request 70 | 71 | To send your changes for the project owner to merge in: 72 | 73 | 1. Submit your pull request 74 | 1. When submitting, if the original project has a `dev` or `integrate` branch, use that as the target branch for your pull request instead of the default `master` 75 | 1. By submitting a pull request you agree for your changes to have the same license as the original plugin 76 | 77 | #### Publish 78 | 79 | To publish your changes as the project owner: 80 | 81 | 1. Switch to the master branch: 82 | 83 | ```bash 84 | git checkout master 85 | ``` 86 | 87 | 1. Merge in the changes of the feature branch (if applicable) 88 | 89 | 1. Increment the version number in the `package.json` file according to the [semantic versioning](http://semver.org) standard, that is: 90 | 91 | 1. `x.0.0` MAJOR version when you make incompatible API changes (note: DocPad plugins must use v2 as the major version, as v2 corresponds to the current DocPad v6.x releases) 92 | 1. `x.y.0` MINOR version when you add functionality in a backwards-compatible manner 93 | 1. `x.y.z` PATCH version when you make backwards-compatible bug fixes 94 | 95 | 1. Add an entry to the changelog following the format of the previous entries, an example of this is: 96 | 97 | ```markdown 98 | ## v6.29.0 2013 April 1 99 | 100 | - Progress on [issue #474](https://github.com/docpad/docpad/issues/474) 101 | - DocPad will now set permissions based on the process's ability 102 | - Thanks to [Avi Deitcher](https://github.com/deitch), [Stephan Lough](https://github.com/stephanlough) for [issue #165](https://github.com/docpad/docpad/issues/165) 103 | - Updated dependencies 104 | ``` 105 | 106 | 1. Commit the changes with the commit title set to something like `v6.29.0. Bugfix. Improvement.` and commit description set to the changelog entry 107 | 108 | 1. Ensure the project is ready for publishing: 109 | 110 | ``` 111 | npm run our:release:prepare 112 | ``` 113 | 114 | 1. Prepare the release and publish it to npm and git: 115 | 116 | ```bash 117 | npm run our:release 118 | ``` 119 | -------------------------------------------------------------------------------- /HISTORY.md: -------------------------------------------------------------------------------- 1 | # History 2 | 3 | ## v1.0.0 2015 October 25 4 | - Some feature 5 | -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Bevry's Project Base Files 2 | 3 | Files we use when scaffolding new projects. 4 | 5 | ## Automatic 6 | 7 | For complete automatic application of our base files, use [`boundation`](https://github.com/bevry/boundation). Eventually boundation will replace this entire repository. 8 | 9 | ## Manual 10 | 11 | For manual application of base files. 12 | 13 | ### Files 14 | 15 | Download the relevant files for your project: 16 | 17 | > - If you have httpie, replace `down` with `http -d` 18 | > - If you have wget, replace `down` with `wget -N` 19 | > - If you have curl, replace `down` with `curl -OL` 20 | 21 | ```shell 22 | down https://raw.githubusercontent.com/bevry/base/master/.editorconfig 23 | down https://raw.githubusercontent.com/bevry/base/master/.flowconfig 24 | down https://raw.githubusercontent.com/bevry/base/master/.gitignore 25 | down https://raw.githubusercontent.com/bevry/base/master/.npmignore 26 | down https://raw.githubusercontent.com/bevry/base/master/CONTRIBUTING.md 27 | down https://raw.githubusercontent.com/bevry/base/master/HISTORY.md 28 | down https://raw.githubusercontent.com/bevry/base/master/LICENSE.md 29 | ``` 30 | 31 | ### Travis 32 | 33 | Refer to [bevry/awesome-travis](https://github.com/bevry/awesome-travis/) for our TravisCI base files. 34 | 35 | ## Legacy 36 | 37 | ### Stylelint Config File 38 | 39 | [Our `.stylelintrc.js` file.](https://github.com/bevry/base/blob/c9fed620552b3334e05de999eab7186ff91fbf2d/.stylelintrc.js) 40 | 41 | ```shell 42 | down https://github.com/bevry/base/blob/c9fed620552b3334e05de999eab7186ff91fbf2d/.stylelintrc.js 43 | ``` 44 | 45 | Dropped in favour of [Boundation](https://github.com/bevry/boundation). 46 | 47 | ### TypeScript Config File 48 | 49 | [Our `tsconfig.json` file.](https://github.com/bevry/base/blob/01aac915b59c84251f9b5182704d05708ac1aa86/tsconfig.json) 50 | 51 | ```shell 52 | down https://github.com/bevry/base/blob/01aac915b59c84251f9b5182704d05708ac1aa86/tsconfig.json 53 | ``` 54 | 55 | Dropped in favour of [Boundation](https://github.com/bevry/boundation). 56 | 57 | ### TravisCI File 58 | 59 | [Our `.travis.yml` file.](https://github.com/bevry/base/blob/01aac915b59c84251f9b5182704d05708ac1aa86/.travis.yml) 60 | 61 | ```shell 62 | down https://github.com/bevry/base/blob/01aac915b59c84251f9b5182704d05708ac1aa86/.travis.yml 63 | ``` 64 | 65 | Dropped in favour of [Boundation](https://github.com/bevry/boundation) and [Awesome Travis](https://github.com/bevry/awesome-travis). 66 | 67 | ### DocPad Setup File 68 | 69 | [Our `docpad-setup.sh` file.](https://github.com/bevry/base/blob/01aac915b59c84251f9b5182704d05708ac1aa86/docpad-setup.sh) 70 | 71 | ```shell 72 | down https://github.com/bevry/base/blob/01aac915b59c84251f9b5182704d05708ac1aa86/docpad-setup.sh 73 | ``` 74 | 75 | Dropped in favour of [Boundation](https://github.com/bevry/boundation). 76 | 77 | ### ESLint Config File 78 | 79 | [Our `.eslintrc.js` file.](https://github.com/bevry/base/blob/01aac915b59c84251f9b5182704d05708ac1aa86/.eslintrc.js) 80 | 81 | ```shell 82 | down https://github.com/bevry/base/blob/01aac915b59c84251f9b5182704d05708ac1aa86/.eslintrc.js 83 | ``` 84 | 85 | Dropped in favour of [`eslint-config-bevry`](https://github.com/bevry/eslint-config-bevry). 86 | 87 | ### [ESNextGuardian](https://github.com/bevry/esnextguardian) 88 | 89 | [Our `esnextguardian.js` file.](https://github.com/bevry/base/blob/34fc820c8d87f1f21706ce7e26882b6cd5437368/esnextguardian.js) 90 | 91 | ```shell 92 | down https://raw.githubusercontent.com/bevry/base/34fc820c8d87f1f21706ce7e26882b6cd5437368/esnextguardian.js 93 | ``` 94 | 95 | Dropped in favour of [Editions](https://github.com/bevry/editions). 96 | 97 | ### [Nakefile](https://github.com/bevry/base/wiki/Nakefile) 98 | 99 | [Our `nakefile.js` file.](https://github.com/bevry/base/blob/34fc820c8d87f1f21706ce7e26882b6cd5437368/nakefile.js) 100 | 101 | ```shell 102 | down https://raw.githubusercontent.com/bevry/base/34fc820c8d87f1f21706ce7e26882b6cd5437368/nakefile.js 103 | ``` 104 | 105 | Dropped in favour of NPM Scripts. 106 | 107 | ### [Cakefile](http://coffeescript.org/#cake) 108 | 109 | [Our `Cakefile` file.](https://raw.githubusercontent.com/bevry/base/22bbd5999c420c4058fd54becb9b1cd3cd1d70dd/Cakefile) 110 | 111 | ```shell 112 | down https://raw.githubusercontent.com/bevry/base/22bbd5999c420c4058fd54becb9b1cd3cd1d70dd/Cakefile 113 | ``` 114 | 115 | Dropped in favour of NPM Scripts. 116 | 117 | ### [CoffeeLint](http://www.coffeelint.org) 118 | 119 | [Our `coffeelint.json` file.](https://github.com/bevry/base/blob/34fc820c8d87f1f21706ce7e26882b6cd5437368/coffeelint.json) 120 | 121 | ```shell 122 | down https://raw.githubusercontent.com/bevry/base/34fc820c8d87f1f21706ce7e26882b6cd5437368/coffeelint.json 123 | ``` 124 | 125 | ```json 126 | { 127 | "scripts": { 128 | "our:verify:coffeelint": "coffeelint ./source" 129 | } 130 | } 131 | ``` 132 | 133 | Dropped in favour of ESNext. 134 | 135 | ### [Cyclic](https://github.com/bevry/base/wiki/Cyclic) 136 | 137 | [Our `cyclic.js` file.](https://github.com/bevry/base/blob/34fc820c8d87f1f21706ce7e26882b6cd5437368/cyclic.js) 138 | 139 | ```shell 140 | down https://raw.githubusercontent.com/bevry/base/34fc820c8d87f1f21706ce7e26882b6cd5437368/cyclic.js 141 | ``` 142 | 143 | Dropped in favour of npm `>=2`. 144 | 145 | ### [JSHint](http://jshint.com) 146 | 147 | [Our `.jshintrc` file.](https://github.com/bevry/base/blob/b1335ea16811d2870dbde87c3a1a606797db54a0/.jshintrc) 148 | 149 | ```shell 150 | down https://raw.githubusercontent.com/bevry/base/b1335ea16811d2870dbde87c3a1a606797db54a0/.jshintrc 151 | ``` 152 | 153 | Dropped in favour of [ESLint](http://eslint.org). 154 | 155 | ### [JSCS](http://jscs.info) 156 | 157 | [Our `.jscrc` file.](https://github.com/bevry/base/blob/34fc820c8d87f1f21706ce7e26882b6cd5437368/.jscrc) 158 | 159 | ```shell 160 | down https://raw.githubusercontent.com/bevry/base/34fc820c8d87f1f21706ce7e26882b6cd5437368/.jscrc 161 | ``` 162 | 163 | Dropped in favour of [ESLint](http://eslint.org). 164 | 165 | ## History 166 | 167 | [View the commit history for the release history.](https://github.com/bevry/base/commits/master) 168 | 169 | ## License 170 | 171 | Licensed under the [Creative Commons Zero](http://creativecommons.org/publicdomain/zero/1.0/) making it [public domain](https://en.wikipedia.org/wiki/Public_domain) so you can do whatever you wish with it without worry (you can even remove this notice!) 172 |
Copyright © 2011+ [Benjamin Lupton](http://balupton.com) 173 | --------------------------------------------------------------------------------