Rename directory to dir

This affects the command line option, the config file, and the template
rendering context. An alias is provided in the config file and the
template rendering context, so use of `directory` will still work here.

Author: rossmacarthur

README.md

@@ -269,9 +269,8 @@ github = "sindresorhus/pure"
 proto = "ssh"
 ```
 
-For a plain Git source you should specify the URL with a `git://` or `ssh://`
-protocol. For SSH you will need to specify the username as well (it is `git` for
-GitHub).
+For a plain Git source you should specify the URL with a `git://` or `ssh://` «.
+For SSH you will need to specify the username as well (it is `git` for GitHub).
 
 ```toml
 [plugins.pure]
@@ -295,7 +294,7 @@ remote = "https://github.com/rossmacarthur/pure/raw/master/pure.zsh"
 ### Local
 
 Local sources reference local directories. A Local source must set the `local`
-field and specify a `directory`. Tildes may be used and will be expanded to the
+field and specify a directory. Tildes may be used and will be expanded to the
 current user's home directory.
 
 ```toml
@@ -366,10 +365,10 @@ As template strings they could be represented like this
 ```toml
 [templates]
 source = { value = 'source "{{ filename }}"', each = true }
-PATH = 'export PATH="{{ directory }}:$PATH"'
-FPATH = 'export FPATH="{{ directory }}:$FPATH"'
-path = 'path=( "{{ directory }}" $path )'
-fpath = 'fpath=( "{{ directory }}" $fpath )'
+PATH = 'export PATH="{{ dir }}:$PATH"'
+FPATH = 'export FPATH="{{ dir }}:$FPATH"'
+path = 'path=( "{{ dir }}" $path )'
+fpath = 'fpath=( "{{ dir }}" $fpath )'
 ```
 
 For example if we change the `apply` field for the below plugin, it will only
@@ -398,8 +397,8 @@ Plugins all have the following information that can be used in templates
   for the plugin in the plugins table. However, it is often the name of the
   plugin, so it can be useful to use this name in templates with `{{ name }}`.
 - **A directory.** In git sources this is the location of the cloned repository,
-  for local sources, it is the `directory` specified. This `directory` can be
-  used in templates with `{{ directory }}`.
+  for local sources, it is the directory specified. This directory can be used
+  in templates with `{{ dir }}`.
 - **Zero or more filenames.** These are the matched files in the plugin
   directory either discovered using the the global `match` field or specified as
   a plugin option with `use`. These can be used in templates using `{{ filename
@@ -435,7 +434,7 @@ do this like this
 
 ```toml
 [templates]
-PATH = 'export PATH="$PATH:{{ directory }}"'
+PATH = 'export PATH="$PATH:{{ dir }}"'
 ```
 
 You can then apply it to the plugin like this

src/cli.rs

@@ -80,7 +80,7 @@ struct Add {
 
     /// Which sub directory to use in this plugin.
     #[structopt(long, value_name = "PATH")]
-    directory: Option<String>,
+    dir: Option<String>,
 
     /// Which files to use in this plugin.
     #[structopt(long = "use", value_name = "MATCH")]
@@ -214,7 +214,7 @@ impl Plugin {
             branch,
             rev,
             tag,
-            directory,
+            dir,
             uses,
             apply,
         } = add;
@@ -240,7 +240,7 @@ impl Plugin {
                 inline: None,
                 proto,
                 reference,
-                directory,
+                dir,
                 uses,
                 apply,
             }),
@@ -524,7 +524,7 @@ OPTIONS:
         --branch <BRANCH>        Checkout the tip of a branch
         --rev <SHA>              Checkout a specific commit
         --tag <TAG>              Checkout a specific tag
-        --directory <PATH>       Which sub directory to use in this plugin
+        --dir <PATH>             Which sub directory to use in this plugin
         --use <MATCH>...         Which files to use in this plugin
         --apply <TEMPLATE>...    Templates to apply to this plugin
 
@@ -558,7 +558,7 @@ ARGS:
                 "https://github.com/rossmacarthur/sheldon-test",
                 "--rev",
                 "ad149784a1538291f2477fb774eeeed4f4d29e45",
-                "--directory",
+                "--dir",
                 "missing",
                 "--use",
                 "{name}.sh",
@@ -583,7 +583,7 @@ ARGS:
                 branch: None,
                 rev: Some("ad149784a1538291f2477fb774eeeed4f4d29e45".into()),
                 tag: None,
-                directory: Some("missing".into()),
+                dir: Some("missing".into()),
                 uses: Some(vec_into!["{name}.sh", "*.zsh"]),
                 apply: Some(vec_into!["something", "another-thing"]),
             }))
@@ -603,7 +603,7 @@ ARGS:
                 "0.1.0",
                 "--proto",
                 "ssh",
-                "--directory",
+                "--dir",
                 "missing",
                 "--use",
                 "{name}.sh",
@@ -624,7 +624,7 @@ ARGS:
                 branch: None,
                 rev: None,
                 tag: Some("0.1.0".into()),
-                directory: Some("missing".into()),
+                dir: Some("missing".into()),
                 uses: Some(vec_into!["{name}.sh", "*.zsh"]),
                 apply: Some(vec_into!["something", "another-thing"]),
             }))
@@ -644,7 +644,7 @@ ARGS:
                 "feature",
                 "--proto",
                 "https",
-                "--directory",
+                "--dir",
                 "missing",
                 "--use",
                 "{name}.sh",
@@ -665,7 +665,7 @@ ARGS:
                 branch: Some("feature".into()),
                 rev: None,
                 tag: None,
-                directory: Some("missing".into()),
+                dir: Some("missing".into()),
                 uses: Some(vec_into!["{name}.sh", "*.zsh"]),
                 apply: Some(vec_into!["something", "another-thing"]),
             }))
@@ -700,7 +700,7 @@ ARGS:
                 branch: None,
                 rev: None,
                 tag: None,
-                directory: None,
+                dir: None,
                 uses: Some(vec_into!["{name}.sh", "*.zsh"]),
                 apply: Some(vec_into!["something", "another-thing"]),
             }))
@@ -735,7 +735,7 @@ ARGS:
                 branch: None,
                 rev: None,
                 tag: None,
-                directory: None,
+                dir: None,
                 uses: Some(vec_into!["{name}.sh", "*.zsh"]),
                 apply: Some(vec_into!["something", "another-thing"]),
             }))

src/config.rs

@@ -86,7 +86,7 @@ pub enum Source {
     /// A remote file.
     Remote { url: Url },
     /// A local directory.
-    Local { directory: PathBuf },
+    Local { dir: PathBuf },
 }
 
 /// The actual plugin configuration.
@@ -114,7 +114,8 @@ pub struct RawPlugin {
     /// Which directory to use in this plugin.
     ///
     /// This directory can contain template parameters.
-    pub directory: Option<String>,
+    #[serde(alias = "directory")]
+    pub dir: Option<String>,
     /// Which files to use in this plugin's directory. If this is `None` then
     /// this will figured out based on the global `matches` field.
     ///
@@ -134,7 +135,7 @@ pub struct ExternalPlugin {
     /// Specifies how to retrieve this plugin.
     pub source: Source,
     /// Which directory to use in this plugin.
-    pub directory: Option<String>,
+    pub dir: Option<String>,
     /// What files to use in the plugin's directory.
     pub uses: Option<Vec<String>>,
     /// What templates to apply to each matched file.
@@ -526,7 +527,7 @@ impl RawPlugin {
             inline,
             proto,
             reference,
-            directory,
+            dir,
             uses,
             apply,
         } = self;
@@ -568,8 +569,8 @@ impl RawPlugin {
                 TempSource::External(Source::Remote { url })
             }
             // `local` type
-            (None, None, None, None, Some(directory), None) => {
-                TempSource::External(Source::Local { directory })
+            (None, None, None, None, Some(dir), None) => {
+                TempSource::External(Source::Local { dir })
             }
             // `inline` type
             (None, None, None, None, None, Some(raw)) => TempSource::Inline(raw),
@@ -597,7 +598,7 @@ impl RawPlugin {
                 Ok(Plugin::External(ExternalPlugin {
                     name,
                     source,
-                    directory,
+                    dir,
                     uses,
                     apply,
                 }))
@@ -606,7 +607,7 @@ impl RawPlugin {
                 let unsupported = [
                     ("`proto` field is", proto.is_some()),
                     ("`branch`, `tag`, and `rev` fields are", is_reference_some),
-                    ("`directory` field is", directory.is_some()),
+                    ("`dir` field is", dir.is_some()),
                     ("`use` field is", uses.is_some()),
                     ("`apply` field is", apply.is_some()),
                 ];
@@ -912,7 +913,7 @@ mod tests {
                 url: url.clone(),
                 reference: None,
             },
-            directory: None,
+            dir: None,
             uses: None,
             apply: None,
         });
@@ -935,7 +936,7 @@ mod tests {
                 url: Url::parse("git://gist.github.com/579d02802b1cc17baed07753d09f5009").unwrap(),
                 reference: None,
             },
-            directory: None,
+            dir: None,
             uses: None,
             apply: None,
         });
@@ -964,7 +965,7 @@ mod tests {
                     .unwrap(),
                 reference: None,
             },
-            directory: None,
+            dir: None,
             uses: None,
             apply: None,
         });
@@ -988,7 +989,7 @@ mod tests {
                     .unwrap(),
                 reference: None,
             },
-            directory: None,
+            dir: None,
             uses: None,
             apply: None,
         });
@@ -1016,7 +1017,7 @@ mod tests {
                 url: Url::parse("git://github.com/rossmacarthur/sheldon-test").unwrap(),
                 reference: None,
             },
-            directory: None,
+            dir: None,
             uses: None,
             apply: None,
         });
@@ -1043,7 +1044,7 @@ mod tests {
                 url: Url::parse("https://github.com/rossmacarthur/sheldon-test").unwrap(),
                 reference: None,
             },
-            directory: None,
+            dir: None,
             uses: None,
             apply: None,
         });
@@ -1069,7 +1070,7 @@ mod tests {
                 url: Url::parse("ssh://git@github.com/rossmacarthur/sheldon-test").unwrap(),
                 reference: None,
             },
-            directory: None,
+            dir: None,
             uses: None,
             apply: None,
         });
@@ -1096,7 +1097,7 @@ mod tests {
         let expected = Plugin::External(ExternalPlugin {
             name: name.clone(),
             source: Source::Remote { url: url.clone() },
-            directory: None,
+            dir: None,
             uses: None,
             apply: None,
         });
@@ -1158,9 +1159,9 @@ mod tests {
         let expected = Plugin::External(ExternalPlugin {
             name: name.clone(),
             source: Source::Local {
-                directory: "/home/temp".into(),
+                dir: "/home/temp".into(),
             },
-            directory: None,
+            dir: None,
             uses: None,
             apply: None,
         });