Coder Social home page Coder Social logo

Comments (4)

aalmiray avatar aalmiray commented on June 11, 2024

Alright, does this mean documents have access to variables such as ${project-artifactId} ? What's the naming convention for variables that may have a common root (such as project)? Alternatives are

  • underscore as separator, e.g, project_artifactId
  • dot as separator, e.g, project.artifactId
  • camel case, e.g, projectArtifactId

More over, Maven proposes names such as 'groupId' and 'artifactId' where as gradle favors 'group' and 'name'. Whichever name those build tools use internally we should have a convention within asciidoctor (maven's, gradle's or our own).

from asciidoctor-gradle-plugin.

mojavelinux avatar mojavelinux commented on June 11, 2024

I agree we should use something that doesn't bind it to the conventions of a build tool. I'm partial to "group", "artifact" and "version", but I'd be open to "name" instead of "artifact".

The dot separator won't work in AsciiDoc since it's not a legal attribute name character. In Asciidoctor 1.5.0 or 1.6.0 we're going to make spaces, underscores and hyphens insignificant, so you can write it in whatever style you want and it will resolve to the same name.

I think internally, it makes the most sense to use a hyphen, since that is the character used by several existing built-in attributes.

  • project-artifact (or project-name)
  • project-group
  • project-version

wdyt?

We need to sync with the Maven plugin on this too. cc: @LightGuard

from asciidoctor-gradle-plugin.

aalmiray avatar aalmiray commented on June 11, 2024

Agreed. My gut feeling says "project-name" is a much better choice 😉

from asciidoctor-gradle-plugin.

aalmiray avatar aalmiray commented on June 11, 2024

I'm leanign towards

  • project-name
  • project-group
  • project-version

Will take this issue this week.

from asciidoctor-gradle-plugin.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.