Giter Site home page Giter Site logo

Simulated run option about pml-companion HOT 3 OPEN

pml-lang avatar pml-lang commented on June 16, 2024
Simulated run option

from pml-companion.

Comments (3)

pml-lang avatar pml-lang commented on June 16, 2024

I propose a "simulated run" option that will show the results of a command without truly executing it.

Excellent idea!

--simulate

As far as I know, the argument dryrun is often used for this kind of execution. So maybe we can adhere to that convention. Although IMO simulate is a better term for non-technical people.

show the intended changes to the generated output

I suppose that "intended changes" relates to changes in the file system (directory/file created/copied, etc), and not to changes in the resulting HTML document, right?

An alternatve implementation might be like Terraform's --auto-approve option, wherewith the intended changes are revealed, and the executable by default pauses for user input

That would be more sophisticated, but also a bit more time-consuming to implement. I suggest to start with a simulate/dryrun option, and add more options later, if asked by the community.

also helpfully reveal the locations of the output_directory, resources_directory, etc.

Yes!

dynamically show certain "default values" as resolved relative to your file system

Very helpful too.

Thanks!

from pml-companion.

coemgenuslcp avatar coemgenuslcp commented on June 16, 2024

I hold no personal preference either way of the name choice. I like "simulate" for its clarity, but also "dry run" is a common term, and one that is really not obscure or confusing.

I suppose that "intended changes" relates to changes in the file system (directory/file created/copied, etc), and not to changes in the resulting HTML document, right?

Indeed, showing the files that will be generated or replaced is likely sufficient for the near future. Content changes would obviously be more intricate to implement, and so a topic not worth treating immediately.

from pml-companion.

pml-lang avatar pml-lang commented on June 16, 2024

Content changes would obviously be more intricate to implement, and so a topic not worth treating immediately.

True

from pml-companion.

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.