Настроить Карму для загрузки pegjs с requirejs
Попытка протестировать проект с использованием PegJS и requirejs.
У меня есть несколько исходных файлов, реализованных в виде модуля (define) AMD, который загружается через требуемый API. Ниже структуры каталога:
js/
somefile.js
main.js
parser.js
test/
parser.spec.js
Я написал модуль parser.js, чтобы загрузить файл грамматики PegJS и использовать PegJS для создания парсера:
define(function() {
'use strict';
var PEG = require('pegjs');
var grammarFile = 'grammar.peg'
return {
parse: function(fs, content, debug) {
var grammar = fs.readFileSync(grammarFile, 'utf8').toString();
// Build parser from grammar
var parser = PEG.buildParser(grammar, { trace: debug });
[...]
Это отлично работает с main.js, выполненным в командной строке с помощью node.
Теперь я хочу проверить свой проект, используя карму, жасмин и PhantomJS. У меня есть karma.conf.js:
frameworks: ['jasmine', 'requirejs'],
files: [
{ pattern: './test/**/*.spec.js', included: false },
{ pattern: './js/**/*.js', included: false},
'./test/test-main.js',
],
Также у вас есть файл bootstrap с требованием test-main.js, который настроен таким образом:
'use strict';
var allTestFiles = [];
var TEST_REGEXP = /(spec|test)\.js$/i;
// Get a list of all the test files to include
Object.keys(window.__karma__.files).forEach(function(file) {
console.log(file);
if (TEST_REGEXP.test(file)) {
// Normalize paths to RequireJS module names.
// If you require sub-dependencies of test files to be loaded as-is (requiring file extension)
// then do not normalize the paths
var normalizedTestModule = file.replace(/^\/base\/|\.js$/g, '');
allTestFiles.push(file);
}
});
require.config({
// Karma serves files under /base, which is the basePath from your config file
baseUrl: '/base/js',
// dynamically load all test files
deps: allTestFiles,
// we have to kickoff jasmine, as it is asynchronous
callback: window.__karma__.start
});
Теперь, когда я запускаю свой тест (grunt karma
), я получил эту ошибку:
PhantomJS 1.9.8 (Linux 0.0.0) ERROR: Error{message: 'Module name "pegjs" has not been loaded yet for context: _. Use require([])
Поэтому я пытаюсь включить pegjs в файлы, загруженные Karma таким образом karma.conf.js:
files: [
{ pattern: 'node_modules/pegjs/lib/**/*.js', included: true },
{ pattern: './test/**/*.spec.js', included: false },
{ pattern: './js/**/*.js', included: false},
'./test/test-main.js'
],
Когда я это сделаю, я все равно получаю сообщение об ошибке:
Error: Module name "utils/arrays" has not been loaded yet for context: _. Use require([])
Внутри модуля pegjs действительно есть файл arrays.js:
compiler/
compiler.js
grammar-error.js
parser.js
peg.js
utils/
arrays.js
classes.js
objects.js
Итак, пытаясь включить массивы:
files: [
{ pattern: 'node_modules/pegjs/lib/utils/arrays.js', included: true },
{ pattern: 'node_modules/pegjs/lib/**/*.js', included: true },
{ pattern: './test/**/*.spec.js', included: false },
{ pattern: './js/**/*.js', included: false},
'./test/test-main.js'
],
Я получаю:
ReferenceError: Can't find variable: module
at /blabla/node_modules/pegjs/lib/utils/arrays.js:108
Из-за:
108 module.exports = arrays;
Итак, чтобы загрузить модуль npm, я попытался загрузить модуль bower следующим образом:
files: [
{ pattern: 'bower_components/pegjs/peg-0.9.0.js', included: true },
{ pattern: './test/**/*.spec.js', included: false },
{ pattern: './js/**/*.js', included: false},
'./test/test-main.js'
],
И здесь вы снова:
PhantomJS 1.9.8 (Linux 0.0.0) ERROR: Error{message: 'Module name "pegjs" has not been loaded yet for context: _. Use require([])
Также старался не включать pegjs в созданную кармой веб-страницу:
files: [
{ pattern: 'bower_components/pegjs/peg-0.9.0.js', included: false },
{ pattern: './test/**/*.spec.js', included: false },
{ pattern: './js/**/*.js', included: false},
'./test/test-main.js'
],
Но он терпит неудачу:
PhantomJS 1.9.8 (Linux 0.0.0) ERROR: 'There is no timestamp for /base/bower_components/pegjs/peg-0.9.0!'
Попробовал поместить папку bower_component внутри папки js, но не повезло.
Так что я не знаю, должны были идти отсюда... Не удалось найти что-то важное в Google или здесь. Кажется, что это определенная проблема, связанная с требованием /pegjs с кармой... Любая идея приветствуется.
ОБНОВЛЕНИЕ после ответа dan:
Поэтому я переключаюсь с синхронного запроса на асинхронное требование в parser.js:
define(['../bower_components/pegjs/peg-0.9.0'], function(PEG) {
'use strict';
var grammarFile = 'grammar.peg'
return {
parse: function(fs, content, debug) {
var grammar = fs.readFileSync(grammarFile, 'utf8').toString();
// Build parser from grammar
var parser = PEG.buildParser(grammar, { trace: debug });
[...]
Попробовал включить компонент pegjs bower в karma.conf.js:
{ pattern: 'bower_components/pegjs/peg-0.9.0.js', included: false },
или не включать его:
{ pattern: 'bower_components/pegjs/peg-0.9.0.js', included: true },
Но всегда получайте ту же ошибку:
Error: Script error for "/blabla/bower_components/pegjs/peg-0.9.0", needed by: /blabla/js/parser.js
http://requirejs.org/docs/errors.html#scripterror
at /blabla/node_modules/requirejs/require.js:140
Да файл существует:
$ file /home/aa024149/share/logofrjs/bower_components/pegjs/peg-0.9.0.js
/blabla/bower_components/pegjs/peg-0.9.0.js: ASCII text, with very long lines
UPDATE2: наконец понял и нашел приемлемое решение.
Ответы
Ответ 1
Итак, с помощью различных ответов и комментариев от dan и piecesOpiland я, наконец, пришел к тому, чтобы делать то, что хочу.
Итак, pegjs, как и многие библиотеки javascript, выпускаются в двух форматах: модули npm и модули bower.
Модули Npm используются для script для node и вызывают из командной строки. Модули Bower используются для script, загруженных в браузер.
Первое недоразумение с моей стороны заключалось в том, что "require" будет работать в node и в браузере нечетко. Это не верно. Кажется, единственный способ потребовать модуль, чтобы он работал в браузере через асинхронный вызов типа:
require(['module'], function(module) {
...
});
Другое недоразумение заключалось в том, что я мог загружать модули npm в браузере. Что-то вроде магии будет работать для различных файлов npm, которые будут загружены моей страницей. Это возможно, но только с использованием специального инструмента, такого как браунировать. Без специального преобразования в браузере может быть загружена только версия bower. Кроме того, модуль pegjs bower выполнен таким образом, что глобальные переменные определяются следующим образом:
var PEG = {
...
}
module.exports = PEG;
В основном, модуль bower подключает глобальную переменную (фактически несколько глобальных переменных) к области верхнего уровня.
Поэтому вместо того, чтобы мой клиентский код (тот, который работает в браузере И в node), загружал модуль, я действительно загружаю модуль в:
- main.js через синхронный запрос к модулю npm следующим образом:
var PEG = require('pegjs');
- main-browser.js через глобальную переменную, которая становится доступной при загрузке pegjs bower script (через тег
<script>
)
Обе эти "сети" затем вводят переменную PEG в мою функцию парсера.
Чтобы карма работала, мне просто нужно включить модуль pegjs bower в созданную страницу (karma.conf.js):
files: [
{ pattern: 'bower_components/pegjs/peg-0.9.0.js', included: true },
{ pattern: './test/**/*.spec.js', included: false },
{ pattern: './js/**/*.js', included: false},
'./test/test-main.js',
],
Ответ 2
Похоже, вы загружаете pegjs через requirejs. Если это так, pegjs не должен быть файлом, который включен. В вашем karma.conf.js вы пробовали следующее:
files: [
{ pattern: 'bower_components/pegjs/peg-0.9.0.js', included: false },
{ pattern: './test/**/*.spec.js', included: false },
{ pattern: './js/**/*.js', included: false},
'./test/test-main.js'
],
Значение для включения указывает, должна ли веб-страница, созданная сервером кармы, иметь тег script для этого файла или нет (см. http://karma-runner.github.io/0.13/config/files.html). Итак, ваш karma.config:
files: [
{ pattern: 'bower_components/pegjs/peg-0.9.0.js', included: true },
{ pattern: './test/**/*.spec.js', included: false },
{ pattern: './js/**/*.js', included: false},
'./test/test-main.js'
],
заставит карму создать веб-страницу с тегом заголовка, подобным:
<head>
<script src="/base/bower_components/pegjs/peg-0.9.0.js"></script>
<script src="/base/require.js"></script>
<script src="/base/test/test-main.js"></script>
</head>
По моему опыту, я видел много похожего на поведение поведения, вызванного маркировкой моих файлов как included: true
. Если есть файл, который вы пытаетесь загрузить с помощью requirejs, убедитесь, что он помечен как included: false
.
Я считаю, что это отмечает его для работы по предварительной обработке, но я не совсем уверен, почему это делает такую разницу.
Ответ 3
Насколько я знаю, Karma - это платформа тестирования, которая будет запускать ваши тесты в браузере.
Это не подходит для тестирования многих модулей node.
В браузере нет возможности сделать это синхронно: var PEG = require('pegjs')
. Вот почему он просит вас использовать require([])
, который вы передаете обратный вызов, который должен выполняться при завершении загрузки pegjs.
Использование версии beg pegjs и обеспечение ее загрузки до вызова require('pegjs')
может помочь здесь. Это обеспечило бы, что pegjs уже загружен для контекста _ (предполагается, что по умолчанию я требую контекст).
Он также не может загружать файлы из файловой системы с помощью fs.readFileSync(grammarFile, 'utf8')
, поэтому вам придется делать это по-другому. Вы можете попросить Карму разместить вашу грамматику привязки, поместив ее в массив файлов, а затем загрузить ее с помощью requirejs текстового плагина.
Если тестируемый модуль предназначен для работы в node.js, а не в браузере, то он может быть более подходящим для использования тестовой среды, которая не запускает код в браузере, но запускает ее в node, поэтому у вас есть все доступные модули node. Если вы нацеливаете это на браузер, я бы переписал его, чтобы более конкретно настроить браузер.