Move pkg json settings and rename settings to camelCase (#656)

* docs: move settings from package.json file page to settings page

* docs: rename kebab case settings to camel case

* fix mistakes

* rename settings

Author: zkochan

docs/cli/config.md

@@ -7,9 +7,9 @@ Aliases: `c`
 
 Manage the configuration files.
 
-The configuration files are in `INI` format.
+The configuration files are in `init` (the global) and `YAML` (the local) formats.
 
-The local configuration file is located in the root of the project and is named `.npmrc`.
+The local configuration file is located in the root of the project and is named `pnpm-workspace.yaml`.
 
 The global configuration file is located at one of the following locations:
 

docs/cli/install.md

@@ -177,7 +177,7 @@ dependencies.
 
 :::warning
 
-Filter currently does not work properly with v8 default config, you have to implicitly set [dedupe-peer-dependents](../settings.md#dedupe-peer-dependents) to `false` to have that work. For more info and progress please refer to [#6300](https://github.com/pnpm/pnpm/issues/6300)
+Filter currently does not work properly with v8 default config, you have to implicitly set [dedupePeerDependents](../settings.md#dedupePeerDependents) to `false` to have that work. For more info and progress please refer to [#6300](https://github.com/pnpm/pnpm/issues/6300)
 
 :::
 

docs/cli/publish.md

@@ -103,13 +103,13 @@ When publishing packages that require two-factor authentication, this option can
 
 ## Configuration
 
-You can also set `git-checks`, `publish-branch` options in the `.npmrc` file.
+You can also set `gitChecks`, `publishBranch` options in the `pnpm-workspace.yaml` file.
 
 For example:
 
-```ini title=".npmrc"
-git-checks=false
-publish-branch=production
+```yaml title="pnpm-workspace.yaml"
+gitChecks: false
+publishBranch: production
 ```
 
 ## Life Cycle Scripts

docs/cli/recursive.md

@@ -25,7 +25,7 @@ when used with the following commands:
 * `test`
 * `add`
 
-If you want the root project be included even when running scripts, set the [include-workspace-root] setting to `true`.
+If you want the root project be included even when running scripts, set the [includeWorkspaceRoot] setting to `true`.
 
 Usage example:
 
@@ -46,11 +46,11 @@ similar to `yarn workspaces`.
 
 When this is set to deep, local packages can also be linked to subdependencies.
 
-Be advised that it is encouraged instead to use [npmrc] for this setting, to
+Be advised that it is encouraged instead to use [`pnpm-workspace.yaml`] for this setting, to
 enforce the same behaviour in all environments. This option exists solely so you
 may override that if necessary.
 
-[npmrc]: ../workspaces.md#link-workspace-packages
+[`pnpm-workspace.yaml`]: ../settings.md#linkWorkspacePackages
 
 ### --workspace-concurrency
 
@@ -106,4 +106,4 @@ pnpm -r --reverse run clean
 
 [Read more about filtering.](../filtering.md)
 
-[include-workspace-root]: ../settings.md#include-workspace-root
+[includeWorkspaceRoot]: ../settings.md#includeWorkspaceRoot

docs/cli/run.md

@@ -152,17 +152,17 @@ Hide workspace prefix from output from child processes that are run in parallel,
 
 [Read more about filtering.](../filtering.md)
 
-## .npmrc settings
+## pnpm-workspace.yaml settings
 
-### enable-pre-post-scripts
+### enablePrePostScripts
 
 * Default: **true**
 * Type: **Boolean**
 
 When `true`, pnpm will run any pre/post scripts automatically. So running `pnpm foo`
 will be like running `pnpm prefoo && pnpm foo && pnpm postfoo`.
 
-### script-shell
+### scriptShell
 
 * Default: **null**
 * Type: **path**
@@ -172,10 +172,10 @@ The shell to use for scripts run with the `pnpm run` command.
 For instance, to force usage of Git Bash on Windows:
 
 ```
-pnpm config set script-shell "C:\\Program Files\\git\\bin\\bash.exe"
+pnpm config set scriptShell "C:\\Program Files\\git\\bin\\bash.exe"
 ```
 
-### shell-emulator
+### shellEmulator
 
 * Default: **false**
 * Type: **Boolean**
@@ -192,7 +192,7 @@ next script will fail on non-POSIX-compliant systems:
 }
 ```
 
-But if the `shell-emulator` setting is set to `true`, it will work on all
+But if the `shellEmulator` setting is set to `true`, it will work on all
 platforms.
 
 [bash-like shell]: https://www.npmjs.com/package/@yarnpkg/shell

docs/docker.md

@@ -90,11 +90,9 @@ You want to save only necessary dependencies for each package, `pnpm deploy` sho
 ```yaml title="pnpm-workspace.yaml"
 packages:
   - 'packages/*'
-```
-
-```ini title=".npmrc"
-sync-injected-deps-after-scripts[]=build
-inject-workspace-packages=true
+syncInjectedDepsAfterScripts:
+- build
+injectWorkspacePackages: true
 ```
 
 ```text title=".dockerignore"

docs/faq.md

@@ -112,10 +112,10 @@ workarounds to make the buggy packages work.
 
 ### Solution 1
 
-In case there are issues, you can use the [`node-linker=hoisted`] setting.
+In case there are issues, you can use the [`nodeLinker: hoisted`] setting.
 This creates a flat `node_modules` structure similar to the one created by `npm`.
 
-[`node-linker=hoisted`]: npmrc#node-linker
+[`nodeLinker: hoisted`]: settings#nodeLinker
 
 ### Solution 2
 

docs/git_branch_lockfiles.md

@@ -7,10 +7,10 @@ Git branch lockfiles allows you to totally avoid lockfile merge conflicts and so
 
 ## Use git branch lockfiles
 
-You can turn on this feature by configuring the `.npmrc` file.
+You can turn on this feature by configuring the `pnpm-workspace.yaml` file.
 
-```ini
-git-branch-lockfile=true
+```yaml
+gitBranchLockfile: true
 ```
 
 By doing this, lockfile name will be generated based on the current branch name.
@@ -45,10 +45,11 @@ After that, all git branch lockfiles will be merged into one `pnpm-lock.yaml`
 
 pnpm allows you to specify `--merge-git-branch-lockfiles` by matching the current branch name.
 
-For instance, by the following setting in `.npmrc` file, `pnpm install` will merge all git branch lockfiles when 
+For instance, by the following setting in `pnpm-workspace.yaml` file, `pnpm install` will merge all git branch lockfiles when 
 running in the `main` branch and the branch name starts with `release`.
 
-```ini
-merge-git-branch-lockfiles-branch-pattern[]=main
-merge-git-branch-lockfiles-branch-pattern[]=release*
+```yaml
+mergeGitBranchLockfilesBranchPattern:
+- main
+- release*
 ```

docs/motivation.md

@@ -55,6 +55,6 @@ creates and why it works fine with the Node.js ecosystem, read:
 
 :::tip
 
-If your tooling doesn't work well with symlinks, you may still use pnpm and set the [node-linker](npmrc#node-linker) setting to `hoisted`. This will instruct pnpm to create a node_modules directory that is similar to those created by npm and Yarn Classic.
+If your tooling doesn't work well with symlinks, you may still use pnpm and set the [nodeLinker](settings#nodeLinker) setting to `hoisted`. This will instruct pnpm to create a node_modules directory that is similar to those created by npm and Yarn Classic.
 
 :::