14 changed files with 701 additions and 0 deletions
@ -0,0 +1,22 @@
@@ -0,0 +1,22 @@
|
||||
# EditorConfig for Spring Security |
||||
# see https://github.com/spring-projects/spring-security/blob/master/CONTRIBUTING.adoc#mind-the-whitespace |
||||
|
||||
root = true |
||||
|
||||
[*] |
||||
end_of_line = lf |
||||
trim_trailing_whitespace = true |
||||
insert_final_newline = true |
||||
max_line_length = 120 |
||||
|
||||
[*.{java,xml}] |
||||
indent_style = tab |
||||
indent_size = 4 |
||||
charset = utf-8 |
||||
continuation_indent_size = 8 |
||||
|
||||
ij_smart_tabs = false |
||||
ij_java_align_multiline_parameters = false |
||||
|
||||
[*.gradle] |
||||
indent_style = tab |
||||
@ -0,0 +1,13 @@
@@ -0,0 +1,13 @@
|
||||
/.gradle/ |
||||
/.idea/* |
||||
/.settings/ |
||||
/.classpath |
||||
/.project |
||||
/build/ |
||||
/node_modules/ |
||||
/package-lock.json |
||||
/*.iml |
||||
/*.ipr |
||||
/*.iws |
||||
!/.idea/checkstyle-idea.xml |
||||
!/.idea/externalDependencies.xml |
||||
@ -0,0 +1,16 @@
@@ -0,0 +1,16 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?> |
||||
<project version="4"> |
||||
<component name="CheckStyle-IDEA"> |
||||
<option name="configuration"> |
||||
<map> |
||||
<entry key="checkstyle-version" value="8.14" /> |
||||
<entry key="copy-libs" value="false" /> |
||||
<entry key="location-0" value="BUNDLED:(bundled):Sun Checks" /> |
||||
<entry key="location-1" value="BUNDLED:(bundled):Google Checks" /> |
||||
<entry key="scan-before-checkin" value="false" /> |
||||
<entry key="scanscope" value="JavaOnlyWithTests" /> |
||||
<entry key="suppress-errors" value="false" /> |
||||
</map> |
||||
</option> |
||||
</component> |
||||
</project> |
||||
@ -0,0 +1,7 @@
@@ -0,0 +1,7 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?> |
||||
<project version="4"> |
||||
<component name="ExternalDependencies"> |
||||
<plugin id="CheckStyle-IDEA" /> |
||||
<plugin id="org.jetbrains.plugins.gradle" /> |
||||
</component> |
||||
</project> |
||||
@ -0,0 +1,33 @@
@@ -0,0 +1,33 @@
|
||||
antora: |
||||
extensions: |
||||
- ./lib/antora/extensions/version-fix.js |
||||
- ./lib/antora/extensions/major-minor-segment.js |
||||
runtime: |
||||
log: |
||||
format: pretty |
||||
site: |
||||
title: Spring Security |
||||
url: https://docs.spring.io/spring-security/reference |
||||
robots: allow |
||||
git: |
||||
ensure_git_suffix: false |
||||
content: |
||||
sources: |
||||
- url: https://github.com/spring-io/spring-generated-docs |
||||
branches: 'spring-projects/spring-security/{main,5.{{6..9},{1..9}+({0..9})}.{x,+({0..9})}}' |
||||
- url: https://github.com/spring-projects/spring-security |
||||
branches: '{main,5.{{6..9},{1..9}+({0..9})}.x}' |
||||
tags: '5.{{6..9},{1..9}+({0..9})}.+({0..9})' |
||||
start_path: docs |
||||
asciidoc: |
||||
attributes: |
||||
page-pagination: '' |
||||
hide-uri-scheme: '@' |
||||
urls: |
||||
latest_version_segment_strategy: redirect:to |
||||
latest_version_segment: '' |
||||
redirect_facility: httpd |
||||
ui: |
||||
bundle: |
||||
url: https://github.com/spring-io/antora-ui-spring/releases/download/latest/ui-bundle.zip |
||||
snapshot: true |
||||
@ -0,0 +1,27 @@
@@ -0,0 +1,27 @@
|
||||
plugins { |
||||
id "io.github.rwinch.antora" version "0.0.2" |
||||
} |
||||
|
||||
group = 'org.springframework.security' |
||||
description = 'Spring Security' |
||||
|
||||
node { |
||||
version = "16.17.0" |
||||
} |
||||
|
||||
antora { |
||||
antoraVersion = "3.1.0" |
||||
arguments = ["--fetch", "--stacktrace"] |
||||
} |
||||
|
||||
tasks.antora { |
||||
environment = [ |
||||
"ALGOLIA_API_KEY" : "82c7ead946afbac3cf98c32446154691", |
||||
"ALGOLIA_APP_ID" : "244V8V9FGG", |
||||
"ALGOLIA_INDEX_NAME" : "security-docs" |
||||
] |
||||
} |
||||
|
||||
repositories { |
||||
mavenCentral() |
||||
} |
||||
Binary file not shown.
@ -0,0 +1,5 @@
@@ -0,0 +1,5 @@
|
||||
distributionBase=GRADLE_USER_HOME |
||||
distributionPath=wrapper/dists |
||||
distributionUrl=https\://services.gradle.org/distributions/gradle-7.4.2-bin.zip |
||||
zipStoreBase=GRADLE_USER_HOME |
||||
zipStorePath=wrapper/dists |
||||
@ -0,0 +1,234 @@
@@ -0,0 +1,234 @@
|
||||
#!/bin/sh |
||||
|
||||
# |
||||
# Copyright © 2015-2021 the original authors. |
||||
# |
||||
# Licensed under the Apache License, Version 2.0 (the "License"); |
||||
# you may not use this file except in compliance with the License. |
||||
# You may obtain a copy of the License at |
||||
# |
||||
# https://www.apache.org/licenses/LICENSE-2.0 |
||||
# |
||||
# Unless required by applicable law or agreed to in writing, software |
||||
# distributed under the License is distributed on an "AS IS" BASIS, |
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
||||
# See the License for the specific language governing permissions and |
||||
# limitations under the License. |
||||
# |
||||
|
||||
############################################################################## |
||||
# |
||||
# Gradle start up script for POSIX generated by Gradle. |
||||
# |
||||
# Important for running: |
||||
# |
||||
# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is |
||||
# noncompliant, but you have some other compliant shell such as ksh or |
||||
# bash, then to run this script, type that shell name before the whole |
||||
# command line, like: |
||||
# |
||||
# ksh Gradle |
||||
# |
||||
# Busybox and similar reduced shells will NOT work, because this script |
||||
# requires all of these POSIX shell features: |
||||
# * functions; |
||||
# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», |
||||
# «${var#prefix}», «${var%suffix}», and «$( cmd )»; |
||||
# * compound commands having a testable exit status, especially «case»; |
||||
# * various built-in commands including «command», «set», and «ulimit». |
||||
# |
||||
# Important for patching: |
||||
# |
||||
# (2) This script targets any POSIX shell, so it avoids extensions provided |
||||
# by Bash, Ksh, etc; in particular arrays are avoided. |
||||
# |
||||
# The "traditional" practice of packing multiple parameters into a |
||||
# space-separated string is a well documented source of bugs and security |
||||
# problems, so this is (mostly) avoided, by progressively accumulating |
||||
# options in "$@", and eventually passing that to Java. |
||||
# |
||||
# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, |
||||
# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; |
||||
# see the in-line comments for details. |
||||
# |
||||
# There are tweaks for specific operating systems such as AIX, CygWin, |
||||
# Darwin, MinGW, and NonStop. |
||||
# |
||||
# (3) This script is generated from the Groovy template |
||||
# https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt |
||||
# within the Gradle project. |
||||
# |
||||
# You can find Gradle at https://github.com/gradle/gradle/. |
||||
# |
||||
############################################################################## |
||||
|
||||
# Attempt to set APP_HOME |
||||
|
||||
# Resolve links: $0 may be a link |
||||
app_path=$0 |
||||
|
||||
# Need this for daisy-chained symlinks. |
||||
while |
||||
APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path |
||||
[ -h "$app_path" ] |
||||
do |
||||
ls=$( ls -ld "$app_path" ) |
||||
link=${ls#*' -> '} |
||||
case $link in #( |
||||
/*) app_path=$link ;; #( |
||||
*) app_path=$APP_HOME$link ;; |
||||
esac |
||||
done |
||||
|
||||
APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit |
||||
|
||||
APP_NAME="Gradle" |
||||
APP_BASE_NAME=${0##*/} |
||||
|
||||
# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. |
||||
DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' |
||||
|
||||
# Use the maximum available, or set MAX_FD != -1 to use that value. |
||||
MAX_FD=maximum |
||||
|
||||
warn () { |
||||
echo "$*" |
||||
} >&2 |
||||
|
||||
die () { |
||||
echo |
||||
echo "$*" |
||||
echo |
||||
exit 1 |
||||
} >&2 |
||||
|
||||
# OS specific support (must be 'true' or 'false'). |
||||
cygwin=false |
||||
msys=false |
||||
darwin=false |
||||
nonstop=false |
||||
case "$( uname )" in #( |
||||
CYGWIN* ) cygwin=true ;; #( |
||||
Darwin* ) darwin=true ;; #( |
||||
MSYS* | MINGW* ) msys=true ;; #( |
||||
NONSTOP* ) nonstop=true ;; |
||||
esac |
||||
|
||||
CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar |
||||
|
||||
|
||||
# Determine the Java command to use to start the JVM. |
||||
if [ -n "$JAVA_HOME" ] ; then |
||||
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then |
||||
# IBM's JDK on AIX uses strange locations for the executables |
||||
JAVACMD=$JAVA_HOME/jre/sh/java |
||||
else |
||||
JAVACMD=$JAVA_HOME/bin/java |
||||
fi |
||||
if [ ! -x "$JAVACMD" ] ; then |
||||
die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME |
||||
|
||||
Please set the JAVA_HOME variable in your environment to match the |
||||
location of your Java installation." |
||||
fi |
||||
else |
||||
JAVACMD=java |
||||
which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. |
||||
|
||||
Please set the JAVA_HOME variable in your environment to match the |
||||
location of your Java installation." |
||||
fi |
||||
|
||||
# Increase the maximum file descriptors if we can. |
||||
if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then |
||||
case $MAX_FD in #( |
||||
max*) |
||||
MAX_FD=$( ulimit -H -n ) || |
||||
warn "Could not query maximum file descriptor limit" |
||||
esac |
||||
case $MAX_FD in #( |
||||
'' | soft) :;; #( |
||||
*) |
||||
ulimit -n "$MAX_FD" || |
||||
warn "Could not set maximum file descriptor limit to $MAX_FD" |
||||
esac |
||||
fi |
||||
|
||||
# Collect all arguments for the java command, stacking in reverse order: |
||||
# * args from the command line |
||||
# * the main class name |
||||
# * -classpath |
||||
# * -D...appname settings |
||||
# * --module-path (only if needed) |
||||
# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. |
||||
|
||||
# For Cygwin or MSYS, switch paths to Windows format before running java |
||||
if "$cygwin" || "$msys" ; then |
||||
APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) |
||||
CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) |
||||
|
||||
JAVACMD=$( cygpath --unix "$JAVACMD" ) |
||||
|
||||
# Now convert the arguments - kludge to limit ourselves to /bin/sh |
||||
for arg do |
||||
if |
||||
case $arg in #( |
||||
-*) false ;; # don't mess with options #( |
||||
/?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath |
||||
[ -e "$t" ] ;; #( |
||||
*) false ;; |
||||
esac |
||||
then |
||||
arg=$( cygpath --path --ignore --mixed "$arg" ) |
||||
fi |
||||
# Roll the args list around exactly as many times as the number of |
||||
# args, so each arg winds up back in the position where it started, but |
||||
# possibly modified. |
||||
# |
||||
# NB: a `for` loop captures its iteration list before it begins, so |
||||
# changing the positional parameters here affects neither the number of |
||||
# iterations, nor the values presented in `arg`. |
||||
shift # remove old arg |
||||
set -- "$@" "$arg" # push replacement arg |
||||
done |
||||
fi |
||||
|
||||
# Collect all arguments for the java command; |
||||
# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of |
||||
# shell script including quotes and variable substitutions, so put them in |
||||
# double quotes to make sure that they get re-expanded; and |
||||
# * put everything else in single quotes, so that it's not re-expanded. |
||||
|
||||
set -- \ |
||||
"-Dorg.gradle.appname=$APP_BASE_NAME" \ |
||||
-classpath "$CLASSPATH" \ |
||||
org.gradle.wrapper.GradleWrapperMain \ |
||||
"$@" |
||||
|
||||
# Use "xargs" to parse quoted args. |
||||
# |
||||
# With -n1 it outputs one arg per line, with the quotes and backslashes removed. |
||||
# |
||||
# In Bash we could simply go: |
||||
# |
||||
# readarray ARGS < <( xargs -n1 <<<"$var" ) && |
||||
# set -- "${ARGS[@]}" "$@" |
||||
# |
||||
# but POSIX shell has neither arrays nor command substitution, so instead we |
||||
# post-process each arg (as a line of input to sed) to backslash-escape any |
||||
# character that might be a shell metacharacter, then use eval to reverse |
||||
# that process (while maintaining the separation between arguments), and wrap |
||||
# the whole thing up as a single "set" statement. |
||||
# |
||||
# This will of course break if any of these variables contains a newline or |
||||
# an unmatched quote. |
||||
# |
||||
|
||||
eval "set -- $( |
||||
printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | |
||||
xargs -n1 | |
||||
sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | |
||||
tr '\n' ' ' |
||||
)" '"$@"' |
||||
|
||||
exec "$JAVACMD" "$@" |
||||
@ -0,0 +1,89 @@
@@ -0,0 +1,89 @@
|
||||
@rem |
||||
@rem Copyright 2015 the original author or authors. |
||||
@rem |
||||
@rem Licensed under the Apache License, Version 2.0 (the "License"); |
||||
@rem you may not use this file except in compliance with the License. |
||||
@rem You may obtain a copy of the License at |
||||
@rem |
||||
@rem https://www.apache.org/licenses/LICENSE-2.0 |
||||
@rem |
||||
@rem Unless required by applicable law or agreed to in writing, software |
||||
@rem distributed under the License is distributed on an "AS IS" BASIS, |
||||
@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
||||
@rem See the License for the specific language governing permissions and |
||||
@rem limitations under the License. |
||||
@rem |
||||
|
||||
@if "%DEBUG%" == "" @echo off |
||||
@rem ########################################################################## |
||||
@rem |
||||
@rem Gradle startup script for Windows |
||||
@rem |
||||
@rem ########################################################################## |
||||
|
||||
@rem Set local scope for the variables with windows NT shell |
||||
if "%OS%"=="Windows_NT" setlocal |
||||
|
||||
set DIRNAME=%~dp0 |
||||
if "%DIRNAME%" == "" set DIRNAME=. |
||||
set APP_BASE_NAME=%~n0 |
||||
set APP_HOME=%DIRNAME% |
||||
|
||||
@rem Resolve any "." and ".." in APP_HOME to make it shorter. |
||||
for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi |
||||
|
||||
@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. |
||||
set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" |
||||
|
||||
@rem Find java.exe |
||||
if defined JAVA_HOME goto findJavaFromJavaHome |
||||
|
||||
set JAVA_EXE=java.exe |
||||
%JAVA_EXE% -version >NUL 2>&1 |
||||
if "%ERRORLEVEL%" == "0" goto execute |
||||
|
||||
echo. |
||||
echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. |
||||
echo. |
||||
echo Please set the JAVA_HOME variable in your environment to match the |
||||
echo location of your Java installation. |
||||
|
||||
goto fail |
||||
|
||||
:findJavaFromJavaHome |
||||
set JAVA_HOME=%JAVA_HOME:"=% |
||||
set JAVA_EXE=%JAVA_HOME%/bin/java.exe |
||||
|
||||
if exist "%JAVA_EXE%" goto execute |
||||
|
||||
echo. |
||||
echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% |
||||
echo. |
||||
echo Please set the JAVA_HOME variable in your environment to match the |
||||
echo location of your Java installation. |
||||
|
||||
goto fail |
||||
|
||||
:execute |
||||
@rem Setup the command line |
||||
|
||||
set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar |
||||
|
||||
|
||||
@rem Execute Gradle |
||||
"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* |
||||
|
||||
:end |
||||
@rem End local scope for the variables with windows NT shell |
||||
if "%ERRORLEVEL%"=="0" goto mainEnd |
||||
|
||||
:fail |
||||
rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of |
||||
rem the _cmd.exe /c_ return code! |
||||
if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 |
||||
exit /b 1 |
||||
|
||||
:mainEnd |
||||
if "%OS%"=="Windows_NT" endlocal |
||||
|
||||
:omega |
||||
@ -0,0 +1,204 @@
@@ -0,0 +1,204 @@
|
||||
// https://gitlab.com/antora/antora/-/issues/132#note_712132072
|
||||
'use strict' |
||||
|
||||
const { posix: path } = require('path') |
||||
|
||||
module.exports.register = function({ config }) { |
||||
this.on('contentClassified', ({ contentCatalog }) => { |
||||
contentCatalog.getComponents().forEach(component => { |
||||
const componentName = component.name; |
||||
const generationToVersion = new Map(); |
||||
component.versions.forEach(version => { |
||||
const generation = getGeneration(version.version); |
||||
const original = generationToVersion.get(generation); |
||||
if (original === undefined || (original.prerelease && !version.prerelease)) { |
||||
generationToVersion.set(generation, version); |
||||
} |
||||
}); |
||||
|
||||
const versionToGeneration = Array.from(generationToVersion.entries()).reduce((acc, entry) => { |
||||
const [ generation, version ] = entry; |
||||
acc.set(version.version, generation); |
||||
return acc; |
||||
}, new Map()); |
||||
|
||||
contentCatalog.findBy({ component: componentName }).forEach((file) => { |
||||
const candidateVersion = file.src.version; |
||||
if (versionToGeneration.has(candidateVersion)) { |
||||
const generation = versionToGeneration.get(candidateVersion); |
||||
if (file.out) { |
||||
if (file.out) { |
||||
file.out.dirname = file.out.dirname.replace(candidateVersion, generation) |
||||
file.out.path = file.out.path.replace(candidateVersion, generation); |
||||
} |
||||
} |
||||
if (file.pub) { |
||||
file.pub.url = file.pub.url.replace(candidateVersion, generation) |
||||
} |
||||
} |
||||
}); |
||||
versionToGeneration.forEach((generation, mappedVersion) => { |
||||
contentCatalog.getComponent(componentName).versions.filter(version => version.version === mappedVersion).forEach((version) => { |
||||
version.url = version.url.replace(mappedVersion, generation); |
||||
}) |
||||
const symbolicVersionAlias = createSymbolicVersionAlias( |
||||
componentName, |
||||
mappedVersion, |
||||
generation, |
||||
'redirect:to' |
||||
) |
||||
symbolicVersionAlias.src.version = generation; |
||||
contentCatalog.addFile(symbolicVersionAlias); |
||||
}); |
||||
}) |
||||
}) |
||||
} |
||||
|
||||
function createSymbolicVersionAlias (component, version, symbolicVersionSegment, strategy) { |
||||
if (symbolicVersionSegment == null || symbolicVersionSegment === version) return |
||||
const family = 'alias' |
||||
const baseVersionAliasSrc = { component, module: 'ROOT', family, relative: '', basename: '', stem: '', extname: '' } |
||||
const symbolicVersionAliasSrc = Object.assign({}, baseVersionAliasSrc, { version: symbolicVersionSegment }) |
||||
const symbolicVersionAlias = { |
||||
src: symbolicVersionAliasSrc, |
||||
pub: computePub( |
||||
symbolicVersionAliasSrc, |
||||
computeOut(symbolicVersionAliasSrc, family, symbolicVersionSegment), |
||||
family |
||||
), |
||||
} |
||||
const originalVersionAliasSrc = Object.assign({}, baseVersionAliasSrc, { version }) |
||||
const originalVersionSegment = computeVersionSegment(component, version, 'original') |
||||
const originalVersionAlias = { |
||||
src: originalVersionAliasSrc, |
||||
pub: computePub( |
||||
originalVersionAliasSrc, |
||||
computeOut(originalVersionAliasSrc, family, originalVersionSegment), |
||||
family |
||||
), |
||||
} |
||||
if (strategy === 'redirect:to') { |
||||
originalVersionAlias.out = undefined |
||||
originalVersionAlias.rel = symbolicVersionAlias |
||||
return originalVersionAlias |
||||
} else { |
||||
symbolicVersionAlias.out = undefined |
||||
symbolicVersionAlias.rel = originalVersionAlias |
||||
return symbolicVersionAlias |
||||
} |
||||
} |
||||
|
||||
|
||||
function computeOut (src, family, version, htmlUrlExtensionStyle) { |
||||
let { component, module: module_, basename, extname, relative, stem } = src |
||||
if (component === 'ROOT') component = '' |
||||
if (module_ === 'ROOT') module_ = '' |
||||
let indexifyPathSegment = '' |
||||
let familyPathSegment = '' |
||||
|
||||
if (family === 'page') { |
||||
if (stem !== 'index' && htmlUrlExtensionStyle === 'indexify') { |
||||
basename = 'index.html' |
||||
indexifyPathSegment = stem |
||||
} else if (extname === '.adoc') { |
||||
basename = stem + '.html' |
||||
} |
||||
} else if (family === 'image') { |
||||
familyPathSegment = '_images' |
||||
} else if (family === 'attachment') { |
||||
familyPathSegment = '_attachments' |
||||
} |
||||
const modulePath = path.join(component, version, module_) |
||||
const dirname = path.join(modulePath, familyPathSegment, path.dirname(relative), indexifyPathSegment) |
||||
const path_ = path.join(dirname, basename) |
||||
const moduleRootPath = path.relative(dirname, modulePath) || '.' |
||||
const rootPath = path.relative(dirname, '') || '.' |
||||
|
||||
return { dirname, basename, path: path_, moduleRootPath, rootPath } |
||||
} |
||||
|
||||
function computePub (src, out, family, version, htmlUrlExtensionStyle) { |
||||
const pub = {} |
||||
let url |
||||
if (family === 'nav') { |
||||
const component = src.component || 'ROOT' |
||||
const urlSegments = component === 'ROOT' ? [] : [component] |
||||
if (version) urlSegments.push(version) |
||||
const module_ = src.module || 'ROOT' |
||||
if (module_ !== 'ROOT') urlSegments.push(module_) |
||||
// an artificial URL used for resolving page references in navigation model
|
||||
url = '/' + urlSegments.join('/') + '/' |
||||
pub.moduleRootPath = '.' |
||||
} else if (family === 'page') { |
||||
const urlSegments = out.path.split('/') |
||||
const lastUrlSegmentIdx = urlSegments.length - 1 |
||||
if (htmlUrlExtensionStyle === 'drop') { |
||||
// drop just the .html extension or, if the filename is index.html, the whole segment
|
||||
const lastUrlSegment = urlSegments[lastUrlSegmentIdx] |
||||
urlSegments[lastUrlSegmentIdx] = |
||||
lastUrlSegment === 'index.html' ? '' : lastUrlSegment.substr(0, lastUrlSegment.length - 5) |
||||
} else if (htmlUrlExtensionStyle === 'indexify') { |
||||
urlSegments[lastUrlSegmentIdx] = '' |
||||
} |
||||
url = '/' + urlSegments.join('/') |
||||
} else { |
||||
url = '/' + out.path |
||||
if (family === 'alias' && !src.relative.length) pub.splat = true |
||||
} |
||||
|
||||
pub.url = ~url.indexOf(' ') ? url.replace(SPACE_RX, '%20') : url |
||||
|
||||
if (out) { |
||||
pub.moduleRootPath = out.moduleRootPath |
||||
pub.rootPath = out.rootPath |
||||
} |
||||
|
||||
return pub |
||||
} |
||||
|
||||
function computeVersionSegment (name, version, mode) { |
||||
if (mode === 'original') return !version || version === 'master' ? '' : version |
||||
const strategy = this.latestVersionUrlSegmentStrategy |
||||
// NOTE: special exception; revisit in Antora 3
|
||||
if (!version || version === 'master') { |
||||
if (mode !== 'alias') return '' |
||||
if (strategy === 'redirect:to') return |
||||
} |
||||
if (strategy === 'redirect:to' || strategy === (mode === 'alias' ? 'redirect:from' : 'replace')) { |
||||
const component = this.getComponent(name) |
||||
const componentVersion = component && this.getComponentVersion(component, version) |
||||
if (componentVersion) { |
||||
const segment = |
||||
componentVersion === component.latest |
||||
? this.latestVersionUrlSegment |
||||
: componentVersion === component.latestPrerelease |
||||
? this.latestPrereleaseVersionUrlSegment |
||||
: undefined |
||||
return segment == null ? version : segment |
||||
} |
||||
} |
||||
return version |
||||
} |
||||
|
||||
function getGeneration(version) { |
||||
if (!version) return version; |
||||
const firstIndex = version.indexOf('.') |
||||
if (firstIndex < 0) { |
||||
return version; |
||||
} |
||||
const secondIndex = version.indexOf('.', firstIndex + 1); |
||||
const result = version.substr(0, secondIndex); |
||||
return result; |
||||
} |
||||
|
||||
function out(args) { |
||||
console.log(JSON.stringify(args, no_data, 2)); |
||||
} |
||||
|
||||
|
||||
function no_data(key, value) { |
||||
if (key == "data" || key == "files") { |
||||
return value ? "__data__" : value; |
||||
} |
||||
return value; |
||||
} |
||||
@ -0,0 +1,35 @@
@@ -0,0 +1,35 @@
|
||||
// https://gitlab.com/antora/antora/-/issues/132#note_712132072
|
||||
'use strict' |
||||
|
||||
|
||||
module.exports.register = function({ config }) { |
||||
this.on('contentAggregated', ({ contentAggregate }) => { |
||||
contentAggregate.forEach(aggregate => { |
||||
if (aggregate.name === "" && aggregate.displayVersion === 5.6) { |
||||
aggregate.name = "ROOT"; |
||||
aggregate.version = "5.6.0-RC1" |
||||
aggregate.startPage = "ROOT:index.adoc" |
||||
aggregate.displayVersion = `${aggregate.version}` |
||||
delete aggregate.prerelease |
||||
} |
||||
if (aggregate.version === "5.6.1" && |
||||
aggregate.prerelease == "-SNAPSHOT") { |
||||
aggregate.version = "5.6.1" |
||||
aggregate.displayVersion = `${aggregate.version}` |
||||
delete aggregate.prerelease |
||||
} |
||||
}) |
||||
}) |
||||
} |
||||
|
||||
function out(args) { |
||||
console.log(JSON.stringify(args, no_data, 2)); |
||||
} |
||||
|
||||
|
||||
function no_data(key, value) { |
||||
if (key == "data" || key == "files") { |
||||
return value ? "__data__" : value; |
||||
} |
||||
return value; |
||||
} |
||||
@ -0,0 +1,14 @@
@@ -0,0 +1,14 @@
|
||||
{ |
||||
"name": "spring-security-docs-site", |
||||
"description": "Spring Security Docs", |
||||
"private": true, |
||||
"dependencies": { |
||||
"@antora/cli": "^3.1.0", |
||||
"@antora/site-generator-default": "^3.1.0" |
||||
}, |
||||
"overrides": { |
||||
"vinyl-fs": { |
||||
"glob-stream": "~7.0" |
||||
} |
||||
} |
||||
} |
||||
Loading…
Reference in new issue