soldotno / vanilla-enterprise-module
Vanilla 企业模块
Requires
- php: >=5.3.3
This package is not auto-updated.
Last update: 2020-01-20 07:05:59 UTC
README
最佳实践
此仓库试图采用开发社区的最佳实践和我们在 Scandinavia Online 使用的标准,创建一个可以作为任何 PHP 模块基础的 vanilla 模块。
要查看许多针对 PHP 开发的最佳实践,我们推荐 http://phptherightway.com/
#先决条件
- phing
- composer
- php
我们可以说,您只需要安装 composer 和 php,然后我们可以通过 composer 下载所有依赖项。但为了将仓库保持最小,我们也期望系统已安装 phing。要运行提供的 build.xml 中所有测试,您还需要 sass、csslint 和 jshint。
#选择标准 ###标准的好处在于种类繁多
空格、缩进和括号位置本身没有意义,但它们会导致程序员失去工作流程,这可能会造成很大的影响。
遵循代码标准意味着所有与我们的代码打交道的人都知道它应该如何结构化。这使得每个人都更容易阅读,这增加了工作流程。
###代码检查器 使用代码检查器是我们自动代码审查控制的第一步。我们使用 PHP Codesniffer。
您可以在此处安装它
http://pear.php.net/package/PHP_CodeSniffer/
或者您可以在您的 composer.json 中添加以下内容以将其包含在项目中
"soldotno/sol_codestandards","dev-master",
"squizlabs/php_codesniffer","1.*",
#####Codesniffer 易于配置和设置特定的代码标准
######Composer 在您的终端中运行以下命令以获取最新版本的 Composer
curl -sS https://getcomposer.org/installer | php
######Zend 框架 2 我们的主要框架是 Zend 框架 2。它是一个稳定且维护良好的框架,拥有良好的记录。
#######JavaScript 对于 JavaScript 验证,我们使用 JSHint (http://www.jshint.com/)。您可以通过 node (npm install -g jshint) 在系统范围内安装它,这将创建一个可执行文件,可以通过执行 'jshint js/' 运行(它将验证 js/ 文件夹中的每个文件)。
######CSS 对于 CSS 验证,我们使用 CSSLint。您可以通过 node (npm install -g csslint) 在系统范围内安装它,这将创建一个可执行文件,可以通过执行 'csslint css/' 运行(它将验证 css/ 文件夹中的每个文件)。
npm install -g qunitjs
或者从 https://qunit.jqueryjs.cn/ 下载。
wget https://phar.phpunit.de/phpunit.phar
chmod +x phpunit.phar
sudo mv phpunit.phar /usr/local/bin/phpunit
或者包含在 composer.json 中,并从供应商文件夹执行
######持续集成 要持续集成上述所有内容,我们使用 Phing。
Phing 可以通过 Composer 包含
"phing/phing","dev-master"
或全局安装。
您使用 build.xml 文件来配置 Phing。本仓库中包含了一个示例 build.xml 文件。
#开始使用 将名为 ./module 的文件夹重命名为您希望使用的模块名称
删除 .git 文件夹,并使用您的新 git 仓库重新初始化
然后进入您的模块文件夹并执行
composer.phar install
使用以下命令构建系统
phing build