Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

User configurable config file location #3191

Closed
wants to merge 5 commits into from
Closed

User configurable config file location #3191

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a964234
Happy New Year!
cdayjr Jan 2, 2021
307bdf5
Allow user set and home directory configuration
cdayjr Jan 2, 2021
9e7645a
Revert unecessary changes from "Happy New Year!"
cdayjr Jan 2, 2021
9161764
Merge pull request #1 from squizlabs/master
cdayjr Mar 27, 2021
89045b5
Merge branch 'main' into user-configurable-config-file-location
cdayjr Mar 27, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
130 changes: 98 additions & 32 deletions src/Config.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,27 @@ class Config
*/
const STABILITY = 'stable';

/**
* ENV variable to check for user specified config file
*
* @var string
*/
const CONFIG_ENV = 'PHP_CODESNIFFER_CONFIG';

/**
* Config directory name.
*
* @var string
*/
const CONFIG_DIR = 'PHP_CodeSniffer';

/**
* Config file name.
*
* @var string
*/
const CONFIG_FILE = 'CodeSniffer.conf';

/**
* An array of settings that PHPCS and PHPCBF accept.
*
Expand Down Expand Up @@ -1557,23 +1578,7 @@ public static function setConfigData($key, $value, $temp=false)
}

if ($temp === false) {
$path = '';
if (is_callable('\Phar::running') === true) {
$path = \Phar::running(false);
}

if ($path !== '') {
$configFile = dirname($path).DIRECTORY_SEPARATOR.'CodeSniffer.conf';
} else {
$configFile = dirname(__DIR__).DIRECTORY_SEPARATOR.'CodeSniffer.conf';
if (is_file($configFile) === false
&& strpos('@data_dir@', '@data_dir') === false
) {
// If data_dir was replaced, this is a PEAR install and we can
// use the PEAR data dir to store the conf file.
$configFile = '@data_dir@/PHP_CodeSniffer/CodeSniffer.conf';
}
}
$configFile = self::getConfigFile();

if (is_file($configFile) === true
&& is_writable($configFile) === false
Expand Down Expand Up @@ -1635,21 +1640,7 @@ public static function getAllConfigData()
return self::$configData;
}

$path = '';
if (is_callable('\Phar::running') === true) {
$path = \Phar::running(false);
}

if ($path !== '') {
$configFile = dirname($path).DIRECTORY_SEPARATOR.'CodeSniffer.conf';
} else {
$configFile = dirname(__DIR__).DIRECTORY_SEPARATOR.'CodeSniffer.conf';
if (is_file($configFile) === false
&& strpos('@data_dir@', '@data_dir') === false
) {
$configFile = '@data_dir@/PHP_CodeSniffer/CodeSniffer.conf';
}
}
$configFile = self::getConfigFile();

if (is_file($configFile) === false) {
self::$configData = [];
Expand Down Expand Up @@ -1700,4 +1691,79 @@ public function printConfigData($data)
}//end printConfigData()


/**
* Returns the path to the config file.
*
* Checks for a configuration file saved in env variable,
* if not provided, checks the XDG_CONFIG_HOME directory per
* https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html
* for a file.
*
* If no file is found falls back to using a file in the PHP_CodeSniffer directory
*
* @return string The path to the config file
*/
private static function getConfigFile()
{
// Check if env file exists before any other logic.
$configFile = getenv(self::CONFIG_ENV);
if (is_file($configFile) === true) {
return $configFile;
}

$path = getenv('XDG_CONFIG_HOME');
if ($path === false) {
// Resort to trying default defined in https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html
// since XDG_CONFIG_HOME is not found.
$path = getenv('HOME');
if ($path !== false) {
$path = $path.DIRECTORY_SEPARATOR.'.config';
}
}

if ($path !== false && is_dir($path) === true) {
// Check if file exists in $XDG_CONFIG_HOME first.
$configFile = implode(
DIRECTORY_SEPARATOR,
[
$path,
self::CONFIG_DIR,
self::CONFIG_FILE,
]
);
if (is_file($configFile) === true) {
return $configFile;
}
}

$path = '';
if (is_callable('\Phar::running') === true) {
$path = \Phar::running(false);
}

if ($path !== '') {
$configFile = dirname($path).DIRECTORY_SEPARATOR.self::CONFIG_FILE;
} else {
$configFile = dirname(__DIR__).DIRECTORY_SEPARATOR.self::CONFIG_FILE;
if (is_file($configFile) === false
&& strpos('@data_dir@', '@data_dir') === false
) {
// If data_dir was replaced, this is a PEAR install and we can
// use the PEAR data dir to store the conf file.
$configFile = implode(
DIRECTORY_SEPARATOR,
[
'@data_dir@',
self::CONFIG_DIR,
self::CONFIG_FILE,
]
);
}
}

return $configFile;

}//end getConfigFile()


}//end class
Loading