Graham Mertz

En résumé

Ce fichier de configuration est une partie cruciale d’une application JavaScript qui utilise RequireJS. Il indique au chargeur :

• Où trouver tous les modules JavaScript.
• Comment gérer les modules qui ne suivent pas le format standard RequireJS (en utilisant shim).
• Comment résoudre les noms de modules vers des chemins spécifiques (en utilisant map).
• Combien de temps attendre pour le chargement des modules.

Comment il est utilisé dans le code

Dans votre code JavaScript,vous utiliseriez require() pour charger des modules :

javascript


require(['jquery','adobe-pass','fly/libs/backbone-1.0.0'],function($,AdobePass,backbone) {


  // Maintenant vous pouvez utiliser jQuery,AdobePass,et Backbone


  // ...votre code ici...


});

Le chargeur RequireJS utiliserait ce fichier de configuration pour :

1. trouver les chemins corrects pour jquery,adobe-pass,et fly/libs/backbone-1.0.0.
2. Charger les dépendances nécessaires pour fly/libs/backbone-1.0.0 (underscore et jquery) en se basant sur la configuration shim.
3. Rendre AdobePass disponible.

Structure générale

Il s’agit d’un objet JSON qui définit comment les modules JavaScript sont chargés et gérés. C’est essentiellement une carte indiquant au chargeur où trouver les dépendances et comment résoudre les noms de modules.

Sections clés

1. paths : C’est la section la plus vitale. Elle définit des alias (noms courts) pour les chemins des modules. Le chargeur utilisera ces alias lorsque vous require() un module.

Exemple : "adobe-pass":"https://sports.cbsimg.net/js/CBSi/app/videoplayer/AdobePass-min.js" signifie que lorsque votre code fait require(['adobe-pass']), le chargeur ira réellement chercher le fichier JavaScript à partir de https://sports.cbsimg.net/js/CBSi/app/VideoPlayer/AdobePass-min.js.

Modèles courants :

de nombreuses entrées pointent vers des CDN (réseaux de diffusion de contenu) comme cdnjs.cloudflare.com ou sports.cbsimg.net. C’est bon pour la performance car les fichiers sont probablement déjà mis en cache par le navigateur de l’utilisateur.

Certaines entrées pointent vers des chemins locaux (par exemple, "fly/libs/backbone-1.0.0"). Ce sont des modules qui font partie du code source de l’application.

1. shim : Cette section est utilisée pour définir les dépendances des modules qui ne les déclarent pas explicitement en utilisant le format de définition de module standard de RequireJS (AMD). C’est une façon de dire au chargeur : “Ce module s’attend à ce que ces autres modules soient disponibles globalement.”

deps : Un tableau de noms de modules dont le module shimmed dépend. Le chargeur…

Okay, this looks like a configuration file for a JavaScript module loader, likely RequireJS. Let’s break down what it represents.

Overall Structure

This is a JSON object that defines how JavaScript modules are loaded and managed. It’s essentially a map telling the loader where too find dependencies and how to resolve module names.

Key Sections

1. paths: This is the most vital section. It defines aliases (short names) for module paths. The loader will use thes aliases when you require() a module.

Example: "adobe-pass":"https://sports.cbsimg.net/js/CBSi/app/VideoPlayer/AdobePass-min.js" means that when your code does require(['adobe-pass']), the loader will actually fetch the JavaScript file from https://sports.cbsimg.net/js/CBSi/app/VideoPlayer/AdobePass-min.js.

Common Patterns:
Many entries point to CDNs (Content Delivery Networks) like cdnjs.cloudflare.com or sports.cbsimg.net. This is good for performance because the files are likely already cached by the user’s browser.
Some entries point to local paths (e.g., "fly/libs/backbone-1.0.0"). These are modules that are part of the application’s codebase.

1. shim: This section is used to define dependencies for modules that don’t explicitly declare them using RequireJS’s standard module definition format (AMD). It’s a way to tell the loader, “This module expects these other modules to be available globally.”

deps: An array of module names that the shimmed module depends on. The loader will make sure these dependencies are loaded before the shimmed module.
exports: A string representing the global variable name that the shimmed module assigns its functionality to. This allows other modules to access the shimmed module’s functionality.

Example:

json
        "fly/libs/backbone-1.0.0":{"deps":["version!fly/libs/underscore","jquery"],"exports":"Backbone"}
        

This means:
fly/libs/backbone-1.0.0 is a module that doesn’t use RequireJS’s standard define() format.
It depends on fly/libs/underscore and jquery. The version! prefix (see below) likely means a specific version is required.
After loading, it will assign its functionality to the global variable Backbone. So, other modules can access Backbone using Backbone.

1. map: This section defines mappings for module names. It’s used to resolve module names to specific paths.

: The asterisk means that these mappings apply to all module names.
Example: "adobe-pass":"https://sports.cbsimg.net/js/CBSi/app/VideoPlayer/AdobePass-min.js" means that whenever you require(['adobe-pass']), it will be resolved to the specified URL.

version!: This is a custom prefix. It’s likely used by the application to specify a particular version of a module. the loader probably has a plugin that handles the version! prefix, perhaps by appending a version number to the module’s URL.In Summary

This configuration file is a crucial part of a JavaScript application that uses RequireJS. It tells the loader:

Where to find all the JavaScript modules.
How to handle modules that don’t follow the standard RequireJS format (using shim).
How to resolve module names to specific paths (using map).
How long to wait for modules to load.

How it’s Used in Code

In your JavaScript code, you would use require() to load modules:

javascript
require(['jquery', 'adobe-pass', 'fly/libs/backbone-1.0.0'],function($,AdobePass,Backbone) {
  // Now you can use jQuery,AdobePass,and Backbone
  // ...your code hear...
});

The RequireJS loader would use this configuration file to:

1. Find the correct paths for jquery,adobe-pass,and fly/libs/backbone-1.0.0.
2. Load the necessary dependencies for fly/libs/backbone-1.0.0 (underscore and jquery) based on the shim configuration.
3. Make the AdobePass