Meteor - Package.js

W tym rozdziale dowiemy się, jak stworzyć własny pakiet meteorytów.

Tworzenie pakietu

Dodajmy nowy folder na pulpicie, w którym zostanie utworzony pakiet. Użyjemy okna wiersza poleceń.

C:\Users\username\Desktop\meteorApp> mkdir packages

Teraz możemy utworzyć pakiet w folderze, który utworzyliśmy powyżej. Uruchom następujące polecenie w wierszu polecenia.Username to nazwa użytkownika Meteor Developer, a package-name to nazwa pakietu.

C:\Users\username\Desktop\meteorApp\packages>meteor create --package username:package-name

Dodawanie pakietu

Aby móc dodać pakiet lokalny do naszej aplikacji, musimy ustawić rozszerzenie ENVIRONMENT VARIABLEdzięki temu Meteor załaduje pakiet z lokalnego folderu. Kliknij prawym przyciskiem myszy ikonę komputera i wybierzproperties/Advanced system settings/Environment Variables/NEW.

Variable Name Powinien być PACKAGE_DIRS. Variable Valuepowinna być ścieżką do utworzonego przez nas folderu. W naszym przypadku,C:\Users\username\Desktop\meteorApp\packages.

Nie zapomnij ponownie uruchomić command prompt po dodaniu nowej zmiennej środowiskowej.

Możemy teraz dodać pakiet do naszej aplikacji, uruchamiając następujący kod -

C:\Users\username\Desktop\meteorApp>meteor add username:package-name

Pliki pakietów

W utworzonym przez nas pakiecie zostaną znalezione następujące cztery pliki.

  • package-name-test.js
  • package-name.js
  • package.js
  • README.md

Pakiet testowy (nazwa-pakietu-test.js)

Oferty Meteor tinytestpakiet do testowania. Zainstalujmy go najpierw, używając następującego polecenia w oknie wiersza polecenia.

C:\Users\username\Desktop\meteorApp>meteor add tinytest

Jeśli otworzymy package-name-test.js, zobaczymy domyślny przykład testu. Wykorzystamy ten przykład do przetestowania aplikacji. Uwaga: podczas tworzenia pakietów meteor zawsze lepiej jest napisać własne testy.

Aby przetestować pakiet, uruchommy ten kod w wierszu polecenia.

C:\Users\username\Desktop>meteor test-packages packages/package-name

Otrzymamy następujący wynik.

plik package.js

To jest plik, w którym możemy napisać kod. Stwórzmy prostą funkcjonalność dla naszego pakietu. Nasz pakiet zapisze jakiś tekst w konsoli.

packages / package.js

myPackageFunction = function() {
   console.log('This is simple package...');
}

nazwa-pakietu.js Plik

To jest plik, w którym możemy ustawić konfigurację pakietu. Wrócimy do tego później, ale na razie musimy wyeksportowaćmyPackageFunctionwięc możemy go używać w naszej aplikacji. Musimy dodać to w środkuPackage.onUsefunkcjonować. Plik będzie wyglądał mniej więcej tak.

pakiety / nazwa-pakietu.js

Package.describe({
   name: 'username:package-name',
   version: '0.0.1',
   
   // Brief, one-line summary of the package.
   summary: '',
   
   // URL to the Git repository containing the source code for this package.
   git: '',
   
   // By default, Meteor will default to using README.md for documentation.
   
   // To avoid submitting documentation, set this field to null.
   documentation: 'README.md'
});

Package.onUse(function(api) {
   api.versionsFrom('1.2.1');
   api.use('ecmascript');
   api.addFiles('mypackage.js');
   api.export('myPackageFunction'); // We are exporting the function we created above...
});

Package.onTest(function(api) {
   api.use('ecmascript');
   api.use('tinytest');
   api.use('username:package-name');
   api.addFiles('package-name-tests.js');
});

Korzystanie z pakietu

Teraz możemy wreszcie zadzwonić do myPackageFunction() z naszego meteorApp.js plik.

packages / package.js

if(Meteor.isClient) {
   myPackageFunction();
}

Konsola zarejestruje tekst z naszego pakietu.

Aby lepiej zrozumieć, w jaki sposób package.js plik można skonfigurować, użyjemy przykładu z oficjalnej dokumentacji Meteor.

To jest przykładowy plik ...

/* Information about this package */
Package.describe({
   
   // Short two-sentence summary.
   summary: "What this does",

   // Version number.
   version: "1.0.0",

   // Optional.  Default is package directory name.
   name: "username:package-name",

   // Optional github URL to your source repository.
   git: "https://github.com/something/something.git",
});

/* This defines your actual package */
Package.onUse(function (api) {

   // If no version is specified for an 'api.use' dependency, use the
   // one defined in Meteor 0.9.0.
   api.versionsFrom('0.9.0');

   // Use Underscore package, but only on the server.
   // Version not specified, so it will be as of Meteor 0.9.0.
   api.use('underscore', 'server');

   // Use iron:router package, version 1.0.0 or newer.
   api.use('iron:[email protected]');

   // Give users of this package access to the Templating package.
   api.imply('templating')

   // Export the object 'Email' to packages or apps that use this package.
   api.export('Email', 'server');

   // Specify the source code for the package.
   api.addFiles('email.js', 'server');
});

/* This defines the tests for the package */
Package.onTest(function (api) {

   // Sets up a dependency on this package
   api.use('username:package-name');

   // Allows you to use the 'tinytest' framework
   api.use('[email protected]');

   // Specify the source code for the package tests
   api.addFiles('email_tests.js', 'server');
});

/* This lets you use npm packages in your package*/
Npm.depends({
   simplesmtp: "0.3.10",
   "stream-buffers": "0.2.5"
});