Код JavaScript¶
Хотя большая часть ядра Django написана на Python, приложения admin и gis содержат код JavaScript.
Пожалуйста, следуйте этим стандартам при написании кода JavaScript для добавления в Django.
Стиль кода¶
Пожалуйста, следуйте стилю отступов, указанному в файле
.editorconfigМы рекомендуем использовать текстовый редактор с поддержкой EditorConfig, чтобы избежать проблем с отступами и пробелами. Большинство файлов JavaScript используют 4 пробела для отступов, но есть некоторые исключения.При именовании переменных используйте
camelCaseвместоunderscore_case. Различные файлы JavaScript иногда используют разный стиль кода. Пожалуйста, старайтесь соответствовать стилю кода каждого файла.Используйте ESLint для проверки кода на наличие ошибок и ошибок стиля. ESLint будет запущен при запуске тестов JavaScript. Мы также рекомендуем установить плагин ESLint в текстовом редакторе.
По возможности пишите код, который будет работать, даже если структура страницы будет позже изменена с помощью JavaScript. Например, при привязке обработчика щелчкоиспользуйте
$('body').on('click', selector, func)вместо$(selector).click(func). Это упрощает для проектов расширение поведения Django по умолчанию с помощью JavaScript.
Патчи JavaScript¶
Система администрирования Django использует фреймворк jQuery для расширения возможностей интерфейса админки. В сочетании с этим особое внимание уделяется производительности JavaScript админки и минимизации общего размера медиафайла администратора.
Тесты JavaScript¶
Тесты JavaScript Django можно запускать в браузере или из командной строки. Тесты находятся в каталоге верхнего уровня js_tests.
Написание тестов¶
Тесты JavaScript Django используют QUnit. Вот пример тестового модуля:
QUnit.module('magicTricks', {
beforeEach: function() {
const $ = django.jQuery;
$('#qunit-fixture').append('<button class="button"></button>');
}
});
QUnit.test('removeOnClick removes button on click', function(assert) {
const $ = django.jQuery;
removeOnClick('.button');
assert.equal($('.button').length, 1);
$('.button').click();
assert.equal($('.button').length, 0);
});
QUnit.test('copyOnClick adds button on click', function(assert) {
const $ = django.jQuery;
copyOnClick('.button');
assert.equal($('.button').length, 1);
$('.button').click();
assert.equal($('.button').length, 2);
});
Пожалуйста, обратитесь к документации QUnit для получения информации о типах утверждений, поддерживаемых QUnit <https://api.qunitjs.com/assert/>`_.
Запуск тестов¶
Тесты JavaScript можно запускать из веб-браузера или из командной строки.
Запуск тестов из веб-браузера¶
Чтобы запустить тесты из веб-браузера, откройте js_tests/tests.html в своем браузере.
Чтобы измерить покрытие кода при запуске тестов, вам нужно просмотреть этот файл по HTTP. Чтобы просмотреть покрытие кода:
Выполните
python -m http.serverиз корневого каталога (не изнутриjs_tests).Откройте http://localhost:8000/js_tests/tests.html в своем веб-браузере.
Тестирование из командной строки¶
Для запуска тестов из командной строки вам необходимо установить Node.js.
После установки Node.js установите зависимости теста JavaScript, выполнив следующее из корня вашего Django:
$ npm install
...\> npm install
Затем запустите тесты с помощью:
$ npm test
...\> npm test