JavaScript 没有一个权威的编码风格指南,取而代之的是一些流行的编码风格:
1. 代码风格比较
1.1 缩进
两个空格,无需更长的缩进,无需Tab缩进:Google、NPM、Node.js、Idiomatic
Tab缩进:jQuery
4个空格:Crockford
1.2 参数和表达式之间的空格
使用紧凑型风格:Google、NPM、Node.js
你可以通过JSHint文档查看可用的选项: http://www.jshint.com/docs/#options
下面根据以上每个分类下的第一种风格来创建一个 .jshintrc 文件。你可以将它放到项目的根目录中,JSHint-avare 代码编辑器将会按照它来统一项目中的所有代码风格。
此外,你应该将下面的头添加到你的 JavaScript 文件中:
在 Node.js 文件中你应该添加:
4. 在提交 Git 之前自动执行 JSHint
如果你想确保所有的 JS 代码与 .jshintrc 中定义的风格保持一致,你可以将下面的内容添加到你的 .git/hooks/pre-commit文件中,当你试图提交任何新修改的文件到项目时会自动执行风格检查。
filenames=($(git diff --cached --name-only HEAD))
which jshint &> /dev/null
if [ $? -ne 0 ];
then
echo "error: jshint not found"
echo "install with: sudo npm install -g jshint"
exit 1
fi
for i in "${filenames[@]}"
do
if [[ $i =~ \.js$ ]];
then
echo jshint $i
jshint $i
if [ $? -ne 0 ];
then
exit 1
fi
fi
done