Skip to content

Commit

Permalink
Merge branch 'main' into fix/vt-declutter-param
Browse files Browse the repository at this point in the history
  • Loading branch information
elias75015 committed Jan 13, 2025
2 parents aadabc6 + f12169b commit f470e35
Show file tree
Hide file tree
Showing 30 changed files with 582 additions and 125 deletions.
54 changes: 54 additions & 0 deletions COMPILE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# Compiler

Si vous souhaitez contribuer au code des extensions Geoplateforme, voici les commandes principales

## Installation des dépendances

``` bash
npm install
```

Attention, il peut parfois y avoir du cache.
Dans ce cas :

``` bash
rm package-lock.json
npm install --force --verbose
```

## Génération des exemples

``` bash
npm run sample:modules
npm run sample:bundle
```

Lance un navigateur avec les pages d'exemples servies sur l'adresse https://localhost:8080/samples/index-modules.html ou https://localhost:8080/samples/index-bundle.html

Les pages html de test d'utilisation sont dans le répertoire *samples-src/*.

## Build des sources

> resultat du build dans le répoertoire *dist/*
``` bash
npm run build
npm run build:bundle
npm run build:modules
```

**Construction des modules**

``` bash
npm run publish
```

Créé le dossier */dist/package/*, et le fichier *.tgz* nommé à partir de la version renseignée dans le package.json (ex. *geopf-extensions-openlayers-1.0.0-beta.1-324.tgz* si la version renseignée des api est 1.0.0-beta.1-234 dans le package.json)

## D'autres commandes utiles

``` bash
npm run eslint
npm run generate-types
npm run generate-jsdoc
```
114 changes: 114 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,114 @@
# Contribuer

Si vous souhaitez contribuer au code des extensions Geoplateforme, voici quelques conseils pratiques et règles à suivre.

<!-- toc -->

- [Ouverture d'un ticket (issue)](#ouverture-dun-ticket-issue)
- [Ouvrir une pull request (PR)](#ouvrir-une-pull-request-pr)
* [On «fork» le projet](#on-%C2%ABfork%C2%BB-le-projet)
* [On code...](#on-code)
* [On soumet une PR...](#on-soumet-une-pr)
- [Liens utiles](#liens-utiles)

<!-- tocstop -->

## Ouverture d'un ticket (issue)

Vous pouvez ouvrir un ticket dans les situations suivantes :

* Signaler une erreur que vous ne pouvez pas résoudre vous-même
* Discuter d'un sujet ou d'une idée relatives au projet
* Proposer une nouvelle fonctionnalité ou une évolution de fonctionnalité

Votre ticket est ensuite pris en compte par les membres de l'équipe ou de la communauté. Et une action peut vous être demandée telle qu'**ouvrir une Pull Request** afin de contribuer...

## Ouvrir une pull request (PR)

Une pull request vous permet de soumettre une proposition d'évolution du code source à l'équipe en charge du projet. Voici comment soumettre une **pull request** !

### On «fork» le projet

- Créez un `fork` du projet sur le Github.
- Cloner le en local. Ce `dépôt distant` sur le Github s'appelle `origin`.
- Ajoutez le dépôt d'origine en tant que `dépôt distant` avec le mot cléf : `upstream` (cf. https://help.github.com/articles/configuring-a-remote-for-a-fork/).
- Si vous avez créé votre `fork` il y a quelque temps, assurez-vous de récupérer les modifications dans votre dépôt local (cf. https://help.github.com/articles/syncing-a-fork/).
- Récupérez les modification le plus souvent possible de "upstream" afin d'être le plus à jour possible, de sorte que lorsque vous soumettez votre demande (PR), les conflits de fusion seront plus faciles à résoudre !

### On code...

- Créez une `nouvelle branche` pour travailler. Nommez la :
- feature-nom-de-la-feature (ex. feature-widget-draw-circle) dans le cas d'une branche qui propose une nouvelle fonctionnalité
- fix-problème (ex. fix-mouse-position-projection-dropdown) dans le cas d'une branche qui propose une correction à un problème. Si le problème corrigé est lié à une issue, ne pas hésiter à mettre son numéro dans le titre de la branche (ex. fix-152-mouse-position-projection-dropdown)

- Dans le répertoire local du projet, installez les dépendances du projet :

``` bash
npm install
```

cf. [COMPILE.md](COMPILE.md) pour plus d'infos.

- Ecrivez testez, corrigez votre `code` sur votre copie locale de votre fork.

Les commandes pour lancer les exemples en mode modules ou bundle:

```
npm run sample:modules
npm run sample:bundle
```
Lance un navigateur avec les pages d'exemples servies sur l'adresse https://localhost:8080/samples/index-modules.html ou https://localhost:8080/samples/index-bundle.html
Les pages html de test d'utilisation sont dans le répertoire *samples-src/*.


- Suivez les règles de codage du projet. Elles sont définies dans le fichier : .eslintrc (style et convention de codage + syntaxe JavaScript). Vous pouvez vérifier le bon respect de ces règles en lançant la tache :

```
npm run eslint
```

- Vérifiez, ajoutez ou adaptez les exemples si nécessaire.

* Les pages d'exemples sont dans le répertoire *samples-src/pages/tests*

- Ajoutez ou modifiez la `documentation` si nécessaire. Si votre PR apporte une modification d'interface à la bibliothèque, mettez à jour la jsDoc en conséquences et vérifiez quelle est bien prise en compte.

La commande

```
npm run generate-jsdoc
```

Vous permet de générer la jsDoc du projet dans le répertoire *jsdoc/*.
Ouvrez ensuite dans votre navigateur le fichier *jsdoc/index.html* et vérifiez que vos modifications sont bien prises en compte.

- Rajoutez vous dans le fichier [CONTRIBUTORS.md](CONTRIBUTORS.md]) si vous n'y êtes pas déjà.

- `Squash` vos commit en un seul avec le `rebase interactif` (cf. https://help.github.com/articles/interactive-rebase) ou via d'autre méthodes (cf. https://gist.github.com/patik/b8a9dc5cd356f9f6f980 par exemple)

- Poussez cette branche sur votre dépôt, sur le dépôt marqué `origin`.


### On soumet une PR...

- De votre `fork`, ouvrez une demande de `pull request` sur cette branche (cf. https://help.github.com/articles/creating-a-pull-request/). Et ciblez sur la branche `main` du dépôt d'origine...
- Référencez tous les problèmes ainsi que la documentation sur votre PR.
- Ajoutez un ou plusieurs label(s) à votre PR
- Utilisez dans vos `commit` des fonctionnalités de GitHub (ex. "Fix #37.").
- Si le responsable demande des modifications supplémentaires, il suffit de les pousser vers votre branche locale, la `pull request` se met à jour automatiquement.
- Une fois que la `pull request` est approuvée, les responsables du projet effectueront le merge (cf. https://help.github.com/articles/merging-a-pull-request/).


## Liens utiles

https://help.github.com/articles/configuring-a-remote-for-a-fork/
https://help.github.com/articles/syncing-a-fork/
https://help.github.com/articles/about-pull-requests/
https://help.github.com/articles/creating-a-pull-request/
https://help.github.com/articles/checking-out-pull-requests-locally/
https://help.github.com/articles/merging-a-pull-request/
https://help.github.com/articles/about-pull-request-merges/
https://help.github.com/articles/interactive-rebase

Un exemple de contribution sur un projet (en français) :
https://git-scm.com/book/fr/v2/GitHub-Contribution-%C3%A0-un-projet
10 changes: 6 additions & 4 deletions CONTRIBUTORS.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,19 @@ Le fichier [CONTRIBUTING.md](CONTRIBUTING.md) définit les règles et pratiques

# Equipe de développement

* [lboulanger](https://github.com/lboulanger)
* [lowzonenose](https://github.com/lowzonenose)
* [elias75015](https://github.com/elias75015)
* [pjjmunier](https://github.com/pjjmunier)
* [gcebelieu](https://github.com/gcebelieu)
* [azarz](https://github.com/azarz)
* [IGNFhc](https://github.com/IGNFhc)

# Autre contributeurs
# Autres contributeurs

* [gcebelieu](https://github.com/gcebelieu)
* [lboulanger](https://github.com/lboulanger)
* [pjjmunier](https://github.com/pjjmunier)
* [ojathelonius](https://github.com/ojathelonius)
* [vcoindet](https://github.com/vcoindet)
* [pprev94](https://github.com/pprev94)
* [sylvainpolletvillard](https://github.com/sylvainpolletvillard)
* [ThomasG77](https://github.com/ThomasG77)
* [RupertBarrow](https://github.com/RupertBarrow)
3 changes: 3 additions & 0 deletions DRAFT_CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ __DATE__

### 🎉 Summary

> upgrade OpenLayers en v10.3.1 🎉
### 💥 Breaking changes

### 📖 Changelog
Expand All @@ -35,6 +37,7 @@ __DATE__
- Positionnement de la fenêtre de résultats d'autocomplétion du searchEngine (#307)
- Mauvais rendu du profil altimétrique (#303)
- Correction du rendu et du comportement du bouton "retour" du layerImport et du geocodage inverse (#316)
- Zoom sur l'étendu pour le format MapBox importé (#320)

* 🔒 [Security]

Expand Down
1 change: 1 addition & 0 deletions build/webpack/bundle.webpack.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,7 @@ module.exports = (env, argv) => {
devtool : "source-map",
stats : "normal",
devServer : {
webSocketServer: false,
server : "https",
open : ["samples/index-bundle.html"],
static : {
Expand Down
1 change: 1 addition & 0 deletions build/webpack/modules.webpack.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,7 @@ module.exports = (env, argv) => {
],
devtool : "source-map",
devServer : {
webSocketServer: false,
server : "https",
open : ["samples/index-modules.html"],
static : {
Expand Down
2 changes: 1 addition & 1 deletion demos/angular-project/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
"private": true,
"dependencies": {
"geopf-extensions-openlayers": "../../dist/package/geopf-extensions-openlayers.tgz",
"ol": "^9.1.0",
"ol": "^10.3.1",
"@gouvfr/dsfr": "^1.11.0"
},
"devDependencies": {
Expand Down
2 changes: 1 addition & 1 deletion demos/esmodule-project/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
},
"dependencies": {
"geopf-extensions-openlayers": "../../dist/package/geopf-extensions-openlayers.tgz",
"ol": "latest",
"ol": "10.3.1",
"@gouvfr/dsfr": "^1.11.0"
}
}
2 changes: 1 addition & 1 deletion demos/react-project/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"@testing-library/react": "^13.4.0",
"@testing-library/user-event": "^13.5.0",
"geopf-extensions-openlayers": "../../dist/package/geopf-extensions-openlayers.tgz",
"ol": "^9.1.0",
"ol": "^10.3.1",
"react": "^18.3.1",
"react-dom": "^18.3.1",
"react-scripts": "5.0.1",
Expand Down
2 changes: 1 addition & 1 deletion demos/vue-project/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
},
"dependencies": {
"geopf-extensions-openlayers": "../../dist/package/geopf-extensions-openlayers.tgz",
"ol": "^9.1.0",
"ol": "^10.3.1",
"vue": "^3.4.21",
"@gouvfr/dsfr": "^1.11.0"
},
Expand Down
6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"name": "geopf-extensions-openlayers",
"description": "French Geoportal Extensions for OpenLayers libraries",
"version": "1.0.0-beta.1-318",
"date": "06/01/2025",
"version": "1.0.0-beta.1-328",
"date": "09/01/2025",
"module": "src/index.js",
"directories": {},
"engines": {
Expand Down Expand Up @@ -33,7 +33,7 @@
"geoportail",
"geoplateforme",
"javascript",
"OpenLayers 8"
"OpenLayers 10"
],
"license": "AGPL-3.0",
"bugs": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,6 @@ <h2>Ajout du gestionnaire de couches avec les options par défaut</h2>

var layerSwitcher = new ol.control.LayerSwitcher({
options :{
position: 'top-right',
panel: true,
}
});
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!-- Library OpenLayers -->
<link rel="stylesheet" href="{{ resources }}/vendor/ol/v8.2.0/ol.css" />
<script src="{{ resources }}/vendor/ol/v8.2.0/ol.js"></script>
<link rel="stylesheet" href="{{ resources }}/vendor/ol/v10.3.1/ol.css" />
<script src="{{ resources }}/vendor/ol/v10.3.1/ol.js"></script>
<!-- Library Access Geoportal Service -->
<script src="{{ baseurl }}/node_modules/geoportal-access-lib/dist/GpServices.js"></script>
<!-- DSFR theme -->
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!-- Library OpenLayers -->
<link rel="stylesheet" href="{{ resources }}/vendor/ol/v8.2.0/ol.css" />
<script src="{{ resources }}/vendor/ol/v8.2.0/ol.js"></script>
<link rel="stylesheet" href="{{ resources }}/vendor/ol/v10.3.1/ol.css" />
<script src="{{ resources }}/vendor/ol/v10.3.1/ol.js"></script>
<!-- Library Access Geoportal Service -->
<script src="{{ baseurl }}/node_modules/geoportal-access-lib/dist/GpServices.js"></script>
<!-- Classic IGN theme -->
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!-- Library OpenLayers -->
<link rel="stylesheet" href="{{ resources }}/vendor/ol/v8.2.0/ol.css" />
<script src="{{ resources }}/vendor/ol/v8.2.0/ol.js"></script>
<link rel="stylesheet" href="{{ resources }}/vendor/ol/v10.3.1/ol.css" />
<script src="{{ resources }}/vendor/ol/v10.3.1/ol.js"></script>
<!-- Library Access Geoportal Service -->
<script src="{{ baseurl }}/node_modules/geoportal-access-lib/dist/GpServices.js"></script>
<!-- DSFR theme -->
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!-- Library OpenLayers -->
<link rel="stylesheet" href="{{ resources }}/vendor/ol/v8.2.0/ol.css" />
<link rel="stylesheet" href="{{ resources }}/vendor/ol/v10.3.1/ol.css" />
<script src="{{ resources }}/vendor/ol/v10.3.1/ol.js"></script>
<!-- Library Access Geoportal Service -->
<script src="{{ baseurl }}/node_modules/geoportal-access-lib/dist/GpServices.js"></script>
Expand Down
Loading

0 comments on commit f470e35

Please sign in to comment.