feat(config): enforce a single netlify-cms folder

BREAKING CHANGE: the cms config file should be placed in the "netlify-cms" folder and named "config.yml" along with the extensions js files

BREAKING CHANGE: remove `extensionsDir` option

closes #21

Author: medfreeman

Diff for: README.md

@@ -47,16 +47,34 @@
 
 ## Usage
 
-### Netlify CMS `config.yml`
+### Netlify CMS module config folder
+
+This module will look for the Netlify CMS config file and extensions in the following folder: `[nuxt.js srcDir]/netlify-cms`.
+
+:information_source: The nuxt.js [srcDir](https://nuxtjs.org/api/configuration-srcdir/) is set to the project root folder by default. If you don't change this value in nuxt config, you'll just have to create the "netlify-cms" directory at your project root folder.
+
+:information_source: If you don't use any of the following two features, there's no need to create this folder.
+
+#### Netlify CMS `config.yml`
 
 You can specify a [custom configuration](https://www.netlifycms.org/docs/#configuration), that will be parsed and merged with the module's [netlify CMS options](#cmsconfig).
 
-You have to place the file in your [project root](https://nuxtjs.org/api/configuration-rootdir/) and name it `netlify-cms.yml` instead of `config.yml`, for clarity.
+You have to place the file in your Netlify CMS module config folder and name it `config.yml`.
 
-:information_source: Note that each path in the file (`media_folder` and collections `folder` fields) will be rewritten to prepend nuxt.js [srcDir](https://nuxtjs.org/api/configuration-srcdir/), so please specify each path relative to this folder.
+:information_source: Note that each path in the file (`media_folder`, collections `folder` fields and collections `file` fields) will be rewritten to prepend nuxt.js [srcDir](https://nuxtjs.org/api/configuration-srcdir/), so please specify each path relative to this folder.
 
 This file can be changed while `nuxt dev` is running, and Netlify CMS will be updated automatically.
 
+#### Netlify CMS extensions
+
+This module will look for [Netlify CMS extensions](https://github.com/netlify/netlify-cms/blob/master/docs/intro.md#customization) in \*.js files contained in Netlify CMS module config folder and subfolders, and include them in the CMS build.
+
+These are of two kinds, [Custom Previews](https://www.netlifycms.org/docs/customization/) and [Widgets](https://www.netlifycms.org/docs/extending/).
+
+:information_source: The global variable `CMS` is available to these javascript files to reference the CMS object.
+
+:information_source: The contents of this directory and subdirectories can be changed while `nuxt dev` is running, and Netlify CMS will be updated automatically.
+
 ## Options
 You can pass options using module options or `netlifyCms` section in `nuxt.config.js`.
 
@@ -83,19 +101,6 @@ cmsConfig wholly reflects [Netlify CMS config.yml](#netlify-cms-configyml), in j
 
 :information_source: The paths are also rewritten according to nuxt.js [srcDir](https://nuxtjs.org/api/configuration-srcdir/)
 
-### `extensionsDir`: 
-- Default: `"netlify-cms"`
-
-extensionsDir defines the directory where this module will look for [Netlify CMS extensions](https://github.com/netlify/netlify-cms/blob/master/docs/intro.md#customization) in *.js files to include in the build.
-
-These are of two kinds, [Custom Previews](https://www.netlifycms.org/docs/customization/) and [Widgets](https://www.netlifycms.org/docs/extending/).
-
-:information_source: This path will be rewritten to prepend nuxt.js [srcDir](https://nuxtjs.org/api/configuration-srcdir/), so please specify it relative to this folder.
-
-:information_source: The global variable `CMS` is available to these javascript files to reference the CMS object.
-
-This directory can be changed while `nuxt dev` is running, and Netlify CMS will be updated automatically.
-
 ## CONTRIBUTING
 
 * ⇄ Pull requests and ★ Stars are always welcome.

Diff for: src/configManager.js

@@ -7,25 +7,22 @@ import _ from "lodash";
 import CmsConfigFile from "./utils/cms.config.file";
 
 const NUXT_CONFIG_KEY = "netlifyCms";
+const NUXT_DIST_DIR = "dist";
 const CMS_CONFIG_KEY = "cmsConfig";
-const CMS_CONFIG_FILENAME = "netlify-cms.yml";
+const CMS_CONFIG_DIR = "netlify-cms";
+const CMS_CONFIG_FILENAME = "config.yml";
 
 // Defaults
 const DEFAULTS = {
   adminPath: "admin",
   adminTitle: "Content Manager",
-  extensionsDir: "netlify-cms",
   cmsConfig: {
     media_folder: "static/uploads"
   }
 };
 
 class ConfigManager {
   constructor(nuxtOptions, moduleOptions) {
-    this._cmsConfigFile = new CmsConfigFile(
-      join(nuxtOptions.rootDir, CMS_CONFIG_FILENAME)
-    );
-
     this._relativeSrcDir = relative(nuxtOptions.rootDir, nuxtOptions.srcDir);
 
     this._userOptions = {
@@ -41,9 +38,17 @@ class ConfigManager {
       CMS_CONFIG_KEY
     );
     options.adminPath = options.adminPath.replace(/\/?$/, "/");
-    options.extensionsDir = join(nuxtOptions.srcDir, options.extensionsDir);
-    options.buildDir = join(nuxtOptions.buildDir, "dist", options.adminPath);
+    options.buildDir = join(
+      nuxtOptions.buildDir,
+      NUXT_DIST_DIR,
+      options.adminPath
+    );
+    options.moduleConfigDir = join(nuxtOptions.srcDir, CMS_CONFIG_DIR);
     this._config = Object.freeze(options);
+
+    this._cmsConfigFile = new CmsConfigFile(
+      join(this._config.moduleConfigDir, CMS_CONFIG_FILENAME)
+    );
   }
 
   get config() {

Diff for: src/webpack.config.js

@@ -21,7 +21,7 @@ export default function webpackNetlifyCmsConfig(
     nuxtOptions.router.base,
     moduleConfig.adminPath
   );
-  const EXTENSIONS_DIR = moduleConfig.extensionsDir;
+  const EXTENSIONS_DIR = moduleConfig.moduleConfigDir;
   const PAGE_TITLE = moduleConfig.adminTitle;
   const PAGE_TEMPLATE = resolve(__dirname, "../lib/template", "index.html");
   const REQUIRE_EXTENSIONS = existsSync(EXTENSIONS_DIR) ? true : false;